Documentation
Introduction Dashboard
Widget Public Pages

Commissions

The commission editor provides a comprehensive interface for managing individual affiliate commission records. Access it by clicking on any commission amount from the commissions list.

Commission Details

Configure commission information using the form at the top of the page.

Basic Information

Order ID
string required
Unique identifier for the original sale transaction. Used to track and reference the order that generated this commission.
Commission Amount
number required
The amount earned by the affiliate partner for this sale. This is the payout amount before any fees or adjustments.
Total Amount
number required
The full order value before commission calculation. Used to calculate commission rates and track revenue.
Coupon Code
string
The coupon code used for this referral. Links the commission to a specific affiliate partner campaign.
Notes
string
Additional notes about this commission (e.g., special terms, adjustments, or contextual information).
Product
object
Product information from the sale displayed in JSON format. Contains details about what was purchased.
Metadata
object
Additional metadata about this commission displayed in JSON format. Contains extra information from integrations.

Commission Statistics

Track commission performance through three key metrics displayed as cards below the settings.

Commission Amount

The payout amount earned by the affiliate partner for this specific sale.

Total Order Amount

The complete value of the order that generated this commission, before any deductions.

Commission Rate

The percentage of the total order amount that was paid as commission. Calculated as (Commission ÷ Total Order) × 100.

Processing Status

View and manage the commission's payment status at the top of the editor.

  • Processed: Commission has been paid to the partner (partner balance updated, payout record created)
  • Unprocessed: Commission is pending payment (partner balance reflects outstanding amount)

Available Actions

Mark as Processed/Unprocessed

Toggle the commission's payment status.

What Happens When You Toggle Status

When marking as Processed:

  • Subtracts commission amount from partner's outstanding balance
  • Creates a payout record for tracking
  • Partner can no longer earn this commission

When marking as Unprocessed:

  • Adds commission amount back to partner's outstanding balance
  • Creates a reversal payout record
  • Commission becomes available for future payout again
Balance Impact
Status changes automatically update partner balances. Processed commissions reduce outstanding balances, while unprocessed commissions increase them.

Delete Commission

Permanently remove the commission record from the system.

  • Requires confirmation
  • Cannot be undone
  • Removes commission from all calculations and reports

Save Changes

Apply any modifications made to commission details.

  • Validates all required fields
  • Updates commission record in database
  • Shows success/error notifications
  • Redirects back to commissions list

Commission Status Indicators

View commission information at the top of the editor:

  • Processing Status: Shows whether the commission has been paid (Processed/Unprocessed)
  • Partner: Displays the affiliate partner who earned this commission, or "Direct sale" for non-affiliate orders
  • Customer: Shows the customer who made the purchase, or "Guest customer" for anonymous orders

Integration Notes

Automatic Balance Management
The processed/unprocessed toggle automatically manages partner balances and creates payout records. Manual balance adjustments are not needed.
Commission Rate Tracking
The commission rate is calculated in real-time and helps you understand the effectiveness of your affiliate partnerships.
Status Change Impact
Changing a commission's status affects partner payouts and balances. Use the processed status carefully, as it impacts financial reporting and partner earnings.
Previous CustomersNextPayouts