📖 DOCUMENTATION v1.0

Complete Shopify MLM App Guide

This guide covers everything — from first-time installation to complex commission scenarios, withdrawal management, affiliate onboarding, and compliance requirements for operating a shopify mlm app.


⚙️ Installation & Setup

01
Install the App
Navigate to the Shopify App Store or your custom installation link. Click "Add App" and grant the required permissions: Customers, Orders, Draft Orders, and Theme modifications. These are mandatory for the shopify mlm commission engine to operate.
02
Configure App Proxy
Go to Shopify Admin → Apps → Unilevel MLM → Settings. Ensure the proxy is set (default: apps/unilevel). This makes the affiliate storefront portal securely accessible at yourstore.com/apps/unilevel.
03
Embed App Blocks
Go to Online Store → Themes → Customize. Add MLM App Blocks to your desired pages to enable the affiliate registration form and referral widgets directly on your storefront.

🛠️ Admin Guide (Merchant Manual)

Step 1: Define the Root Customer

Every MLM tree requires a mathematically defined top-level node — the "Company Node". This is not a real customer account. It is the anchor point from which every single affiliate in your shopify app mlm network hangs. Without this, the dashboard will not render correctly.

Step 2: Choose Your Payout Trigger

Free Trigger: Anyone creating an account on your store becomes an active affiliate immediately — no purchase required. Best for viral growth.

Package-Based Trigger: Customers must purchase a specific MLM package product before their affiliate dashboard activates. Creates an upfront investment, filters serious distributors.

Step 3: Configure Commission Levels

Define the percentage payout for each level (1 through 10). Additionally, configure Matching Bonus percentages, Generation Compression thresholds (minimum active downlines required for a leader qualification), and Leadership Volume Trackers for rank advancement flat bonuses.


💰 The Money Flow (4 Stages)

The most critical concept for merchants using our mlm app shopfiy: earning a commission does NOT mean money instantly leaves your bank account. Money travels through 4 secure stages.

01
Pending Ledger
Order is marked Paid → Shopify fires orders/paid webhook → Engine calculates all commissions and writes them as "Pending" in the database. No real money has moved.
02
Virtual Wallet Credit
Admin navigates to "Run Bulk Payout" → Selects users → Pending commissions move to Virtual Wallet balance. Still no real bank transaction.
03
Withdrawal Request
Affiliate sees wallet balance → Clicks "Cash Out" → Submits a withdrawal request for an amount above the minimum threshold configured by merchant.
04
Approval & Payment
Admin sees the withdrawal queue → Manually transfers real money via bank/PayPal → Clicks "Approve" in the shopify mlm app → Ledger is zeroed out.

⚠️ CRITICAL: Commission Trigger Rules

Rule #1 — Order MUST be marked as "Paid"

The shopify app mlm strictly listens to the orders/paid webhook. Credit card orders are instantly marked "Paid" by Shopify and commissions generate immediately. COD (Cash on Delivery) orders are in "Payment Pending" state. ZERO commissions will generate. The app completely ignores pending orders. You must manually click "Mark as Paid" in Shopify Admin after collecting the cash. Only then will the engine fire.

Rule #2 — The Referring User Must Be Active

If a user is registered but their affiliate status is inactive (e.g., they haven't purchased the required activation package in Package-based mode), they are excluded from commission calculations. The engine uses leadership compression to skip inactive nodes and finds the next active qualifier.


👤 Affiliate User Manual

End users log into their standard Shopify customer account. No external portal needed. Navigate to yourstore.com/apps/unilevel to access the full shopiy app mlm dashboard.

📊
Performance Overview
Total Earnings, Active Team Members, Available Balance.
🔗
Referral Link & QR Code
Copy unique referral URL or share QR code for offline events.
🌳
Team Genealogy
Personal interactive D3.js tree of their own downline.
💳
Withdrawal Management
Submit and track cash-out requests once wallet balance qualifies.

📜 Terms & Conditions Template

1. Commission Eligibility: Commissions are earned only on completely paid, non-refunded purchases. COD orders must be physically collected and marked as "Paid" in Shopify Admin before any commission is generated by the shopify mlm app engine.

2. Self-Referral Prohibition: Creating multiple accounts to earn commissions on personal purchases is strictly prohibited. Violations result in immediate account termination and forfeiture of all unpaid commissions.

3. Payout Thresholds: Affiliates must reach the configured minimum withdrawal amount before requesting a cash-out. The merchant reserves the right to delay payouts during active fraud investigations or chargeback disputes.