Affiliates

{% hint style="info" %} Grow Your Business with Referrals The Affiliate system allows you to create a referral program where customers can earn commissions by promoting your products. Manage affiliates, track referrals, and process payments directly from your OpenCart 4 admin panel. {% endhint %}

Introduction

The Affiliate system in OpenCart 4 enables you to build a powerful referral marketing program. Customers can become affiliates and earn commissions by referring new customers to your store. The system provides comprehensive tracking, commission management, and payment processing tools to help you grow your business through word-of-mouth marketing.

System Configuration

Before using the Affiliate system, configure the basic settings in System → Settings → Option tab:

Setting	Description	Default Value
Affiliate Status	Enable or disable the entire affiliate system	Disabled (0)
Affiliate Approval	Whether affiliate registrations require manual approval	Yes (1)
Affiliate Auto	Auto-add customers to affiliate group after approval	No (0)
Affiliate Group	Customer group for approved affiliates	Default (1)
Affiliate Commission	Default commission percentage for new affiliates	0.00%
Affiliate Expire	Days before affiliate tracking cookies expire	30
Affiliate Terms	Page containing affiliate terms and conditions	None

{% hint style="warning" %} Important: Enable "Affiliate Status" first before affiliates can register or be created. The system must be active for any affiliate functionality to work. {% endhint %}

Accessing the Affiliate Interface

To access the Affiliate management interface:

Log in to your OpenCart admin panel
Navigate to Marketing → Affiliates
You'll see the affiliate list with existing affiliates and filtering options

Creating a New Affiliate

{% stepper %} {% step %} Step 1: Convert an Existing Customer

Click the Add New button (+) in the top-right corner of the affiliate list.

Since affiliates must be existing customers, you'll need to select a customer from your database:

Use the customer autocomplete field to search for customers
Only customers not already affiliated will appear
The system automatically fills in customer details

{% endstep %}

{% step %} Step 2: Configure Affiliate Details

Fill in the Affiliate Details tab:

Tracking Code (Required)

Unique 10-character code for tracking referrals
Can be auto-generated or manually entered
Must be unique across all affiliates

Website

Optional website URL for the affiliate
Used for reference purposes only

Commission (Required)

Percentage commission on referred sales
Can override the default system commission
Enter as a percentage (e.g., 5.00 for 5%)

Tax ID

Optional tax identification number
For business affiliate record-keeping

{% endstep %}

{% step %} Step 3: Configure Payment Method

Select a payment method in the Payment Details tab:

Method	Required Fields	Notes
Cheque	Cheque Payee Name	Physical cheque payments
PayPal	Valid PayPal Email	Electronic PayPal payments
Bank Transfer	Bank Name, Branch Number, SWIFT Code, Account Name, Account Number	Direct bank transfers

Each method has specific validation rules and required fields. Choose the method that matches how you'll pay commissions.

{% endstep %}

{% step %} Step 4: Save and Activate

Click Save to create the affiliate. Depending on your system configuration:

If auto-approval is enabled: The affiliate is immediately active
If manual approval required: The affiliate status is "Pending" until approved
Affiliate receives email notification about their status change

You can edit the affiliate later to change status, commission, or payment details. {% endstep %} {% endstepper %}

Affiliate Status Management

<details> <summary>Pending Approval ⏳</summary>

Requires: Manual admin approval (when config_affiliate_approval = 1)
Behavior: Affiliate cannot track referrals or earn commissions
Action: Admin must manually approve from affiliate edit page
Notification: Affiliate receives approval/denial email

</details> <details> <summary>Active ✅</summary>

Requirements: Approved by admin or auto-approved
Behavior: Can track referrals and earn commissions
Tracking: Unique tracking code is active
Commissions: Accumulates from referred sales

</details> <details> <summary>Disabled ❌</summary>

Set by: Admin manually disabling affiliate
Behavior: Cannot track referrals or earn new commissions
Balance: Existing balance remains but no new commissions
Use case: Temporary suspension or termination

</details>

Commission Structure

<details> <summary>Default Commission</summary>

Configuration: Set in System → Settings → Option tab
Application: Used for new affiliates unless overridden
Format: Percentage (e.g., 5.00 = 5%)
Range: Typically 1-100%, but can be any value

</details> <details> <summary>Individual Commission</summary>

Override: Set per affiliate during creation/editing
Priority: Overrides default commission for that affiliate
Use cases: VIP affiliates, performance-based tiers, special agreements
Adjustment: Can be changed at any time

</details> <details> <summary>Commission Calculation</summary>

Basis: Percentage of total order amount (before tax)
Exclusions: Shipping costs typically excluded
Timing: Calculated when order reaches complete status
Balance: Added to affiliate's balance automatically

</details>

Payment Methods

<details> <summary>Cheque Payments</summary>

Required: Cheque Payee Name (exact name on cheque)
Process: Manual cheque creation and mailing
Tracking: Mark as paid in transaction history
Best for: Traditional businesses, local affiliates

</details> <details> <summary>PayPal Payments</summary>

Required: Valid PayPal email address
Validation: System validates email format
Process: Send payment via PayPal manually
Best for: International affiliates, digital businesses

</details> <details> <summary>Bank Transfer Payments</summary>

Required Fields:
- Bank Name
- ABA/BSB Branch Number
- SWIFT Code (for international)
- Account Name
- Account Number
Process: Initiate transfer through your bank
Best for: Business affiliates, regular commission payments

</details>

Tracking System

<details> <summary>Tracking Code</summary>

Format: 10-character unique code (letters and numbers)
Generation: Auto-generated or manually entered
Uniqueness: System validates no duplicates exist
Usage: Added to referral links (e.g., ?tracking=CODE)

</details> <details> <summary>Referral Links</summary>

Format: yourstore.com?tracking=UNIQUE_CODE
Automatic: Links automatically include tracking for logged-in affiliates
Cookie: Tracking code stored in cookie for 30 days (configurable)
Attribution: Sale attributed to affiliate if cookie present at checkout

</details> <details> <summary>Tracking Reports</summary>

Access: Click "Reports" button on affiliate list
Data: IP address, country, store, date of referral
Filtering: By date range and affiliate
Purpose: Monitor affiliate marketing effectiveness

</details>

Balance and Transactions

<details> <summary>Affiliate Balance</summary>

Display: Shown in affiliate list and edit page
Calculation: Sum of all commissions minus payments
Real-time: Updates automatically with new orders
Viewing: Click balance amount to see transaction history

</details> <details> <summary>Transaction History</summary>

Types: Commission additions, payment subtractions
Access: "History" tab in affiliate edit page
Details: Date, description, amount, order reference
Manual entries: Add transactions for adjustments or manual payments

</details> <details> <summary>Processing Payments</summary>

Check balance: Verify affiliate has payable balance
Process payment: Send payment via chosen method
Add transaction: Record payment in affiliate history
Update balance: Balance reduces by payment amount
Notify affiliate: Optional email notification

</details>

Customer Registration as Affiliate

<details> <summary>Registration Process</summary>

Customer logs in to their account
Navigates to Affiliate section in their account
Completes affiliate application with payment details
Accepts terms and conditions (if configured)
Submits for approval (if manual approval required)
Receives status notification via email

</details> <details> <summary>Required Information</summary>

Payment method and details
Tax ID (optional)
Website (optional)
Terms acceptance (if enabled)
Tracking code (auto-generated)

</details> <details> <summary>Customer Affiliate Panel</summary>

Access: Through customer account dashboard
Features:
- View commission balance
- See tracking code
- Check payment information
- View referral history
- Update payment details
Restrictions: Cannot change commission rate or status

</details>

Advanced Features

<details> <summary>Custom Fields for Affiliates</summary>

Location: Use "affiliate" location for custom fields
Access: Customers → Custom Fields
Purpose: Collect additional information during affiliate registration
Examples: Business registration number, marketing channels, promotional methods

</details> <details> <summary>Affiliate Group Assignment</summary>

Auto-assignment: config_affiliate_auto setting
Group: config_affiliate_group_id setting
Purpose: Automatically add approved affiliates to specific customer group
Use cases: Special pricing, permissions, or marketing for affiliates

</details> <details> <summary>Cookie Expiration Control</summary>

Setting: config_affiliate_expire (days)
Default: 30 days
Purpose: How long tracking cookie remains active
Considerations: Balance between attribution accuracy and privacy

</details>

Bulk Operations

<details> <summary>Export CSV</summary>

Purpose: Export affiliate data for payment processing
Data: Name, email, balance, payment details
Format: CSV for import into accounting software
Access: Export button in affiliate list

</details> <details> <summary>Recalculate Balances</summary>

Purpose: Fix any balance calculation issues
Process: Recalculates all affiliate balances from transaction history
Use case: After system migration or data correction
Caution: Can be resource-intensive for large databases

</details>

Email Notifications

<details> <summary>Approval Notification</summary>

Trigger: Admin approves pending affiliate
Template: admin/view/template/mail/affiliate_approve.twig
Content: Welcome message, tracking code, commission details
Customization: Edit template for your business

</details> <details> <summary>Denial Notification</summary>

Trigger: Admin denies affiliate application
Template: admin/view/template/mail/affiliate_deny.twig
Content: Notification of denial, possible reasons
Consideration: May want to provide alternative contact

</details> <details> <summary>Transaction Notifications</summary>

Trigger: Manual transaction added by admin
Template: admin/view/template/mail/transaction.twig
Content: Transaction details, updated balance
Optional: Can be disabled per transaction

</details>

Best Practices

{% hint style="success" %} Program Management 🤝

Clear Terms: Create comprehensive affiliate terms and conditions
Fair Commission: Set competitive but sustainable commission rates
Regular Payments: Establish consistent payment schedule
Communication: Keep affiliates informed about program changes
Performance Tracking: Monitor top performers and provide support {% endhint %}

{% hint style="warning" %} Compliance & Legal ⚖️

Tax Reporting: Collect necessary tax information for business affiliates
Terms Enforcement: Ensure affiliates follow your marketing guidelines
Payment Compliance: Follow payment processing regulations in your region
Data Privacy: Handle affiliate data according to privacy laws
Contractual Agreements: Consider formal agreements for high-volume affiliates {% endhint %}

{% hint style="info" %} Performance Optimization 📈

Segment Affiliates: Group by performance, niche, or region
Tiered Commissions: Reward top performers with higher rates
Marketing Materials: Provide banners, links, and content for affiliates
Regular Reviews: Periodically review and prune inactive affiliates
A/B Testing: Test different commission structures and promotions {% endhint %}

Troubleshooting

Common Issues

<details> <summary>Tracking not working 🔍</summary>

Solution: Check the following:

Affiliate status: Must be "Active"
Tracking code: Must be valid and unique
Cookie settings: Browser must accept cookies
Link format: Must include ?tracking=CODE parameter
Expiration: Cookie may have expired (default 30 days)

</details> <details> <summary>Commissions not calculating 💰</summary>

Solution: Verify order and affiliate status:

Order status: Must reach "Complete" status
Affiliate status: Must be "Active" at time of order
Tracking cookie: Must be present at checkout
Commission rate: Check affiliate's commission percentage
Order total: Minimum order amount may apply

</details> <details> <summary>Payment method errors 💳</summary>

Solution: Validate payment details:

PayPal: Email must be valid and confirmed
Bank details: All required fields must be complete
Cheque name: Payee name cannot be empty
Format validation: System validates specific formats for each method

</details> <details> <summary>Customer cannot register as affiliate 📝</summary>

Solution: Check system configuration:

Affiliate status: System must be enabled
Customer status: Must be approved customer (not guest)
Already affiliated: Customer cannot be affiliate twice
Terms page: Must be selected if terms required
Custom fields: All required custom fields must be configured

</details> <details> <summary>Balance discrepancies ⚖️</summary>

Solution: Recalculate and audit:

Use recalculate function: In affiliate list tools
Check transaction history: Verify all entries are correct
Audit orders: Confirm commission calculations per order
Check payment records: Ensure all payments recorded

</details>

{% hint style="info" %} System Limitations ⚡

One affiliate per customer: A customer cannot have multiple affiliate accounts
Cookie-based tracking: Requires cookies to be enabled in browsers
Manual payment processing: No automatic payment integration
Commission on complete orders only: Pending/cancelled orders don't earn commission
No multi-tier commissions: Single-level affiliate program only {% endhint %}

{% hint style="success" %} Documentation Summary 📋

You've now learned how to:

Configure and enable the affiliate system in OpenCart 4
Create and manage affiliate accounts
Set up commission structures and payment methods
Track referrals and monitor affiliate performance
Process commission payments and manage balances
Handle affiliate registrations from customers
Apply best practices for successful affiliate programs

Next Steps:

Mail - Send mass emails to affiliates and customers
Coupons - Create discount coupons for affiliate promotions
Customer Groups - Organize affiliates into groups
System Settings - Configure affiliate system options
Custom Fields - Add custom fields for affiliate applications {% endhint %}