Usage

This guide covers daily operations for both administrators and customers using the Referral System extension.

Administrator WorkflowsCopy Anchor Link

Review ApplicationsCopy Anchor Link

1. Open Admin → Referrals → Applications.
2. Use the table filters to locate pending submissions.
3. Click View details to inspect the applicant’s message.
4. Choose Approve & Issue Code or Reject:
   • Approving prompts for referral code settings, coupon details, and optional overrides. Upon save, the applicant receives an approval email (if notifications are enabled).
   • Rejecting requires a reason and sends the “application declined” email.

Manage Referral CodesCopy Anchor Link

1. Navigate to Admin → Referrals → Codes.
2. Use Create to issue a new code manually. Required fields include user, code, default revenue share, and coupon configuration.
3. Click a record to edit overrides, coupon properties, purchase limits, or internal notes.
4. Use Delete to fully remove a code:
   • Associated coupon relationships are detached and the coupon record is deleted.
   • Package overrides disappear, but historic commissions and withdrawals remain for auditing.

Monitor Commissions and WithdrawalsCopy Anchor Link

• Referrals → Commissions: View payout history, filter by status or currency, and drill into individual entries.
• Referrals → Withdrawals: Approve or reject payout requests. Actions update linked commissions (marking them paid or releasing them back to “available”) and trigger notification emails as configured.

Customer ExperienceCopy Anchor Link

Apply for a Referral CodeCopy Anchor Link

1. Visit Client Area → Referrals (/account/referrals).
2. Read requirements, complete the application form, and optionally request a custom code if allowed.
3. Submit the form. The dashboard displays the application status (“Pending” or “Declined” as applicable).

Monitor PerformanceCopy Anchor Link

Once approved, the main dashboard shows:

• Click and purchase metrics for the code.
• Coupon details (default revenue share, customer discount).
• Balance overview per currency (Available, Reserved, Paid, Total).
• Recent commissions with invoice references.
• Recent withdrawal requests with status labels.

Request WithdrawalsCopy Anchor Link

1. Enter a currency, amount, and optional notes.
2. Submit the request. The extension locks available commissions in that currency and creates a withdrawal record for admins to review.
3. Customers receive email updates when the request is approved or rejected.

Share Referral LinksCopy Anchor Link

• The dashboard provides a one-click copy button that generates https://your-domain.tld?ref=CODE.
• Cookies track visitors for the configured number of days. Returning visitors who complete purchases within the window generate commissions automatically.

TipsCopy Anchor Link

• Encourage partners to monitor their dashboard regularly and keep contact details current.
• Audit commission records periodically to confirm overrides and limits behave as expected.
• When deleting codes, inform the partner so they can update marketing materials.

---