Commissions

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

Commission Details

Configure commission information using the form at the top of the page. The page shows what the partner earned on this order, and whether it has been paid out. At the top right you find the Actions menu and the save control: when you change something, Unsaved changes, Discard and Save changes appear. If you try to leave the page with unsaved edits, Yaplet asks first whether to save, discard or stay.

Basic Information

Order ID
string required
The order in your store that earned this commission. Used to track and reference the order that generated it.
Commission
number required
What the partner earns for this order. This is the payout amount before any fees or adjustments.
Order total
number required
What the customer paid for the whole order, before commission calculation. Used to calculate commission rates and track revenue.
Coupon code
string
The partner's coupon the customer used, if any. Links the commission to a specific affiliate partner campaign.
Notes
string
Additional notes about this commission (e.g., special terms, adjustments, or contextual information). Only you and your team see these.
Product
object
The product sold, as your store reported it, displayed in JSON format. Contains details about what was purchased. This is read-only.
Metadata
object
Extra details your store sent with the order, displayed in JSON format. Contains extra information from integrations. This is read-only.

Commission Statistics

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

Commission

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

Order total

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

Commission rate

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

Payment Status

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

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

Available Actions

Mark as paid out / Mark as not paid out

Toggle the commission's payment status. The Actions menu offers whichever of the two fits the commission's current status.

Switching the status does the following.

When marking as paid out:

  • Subtracts commission amount from partner's outstanding balance
  • Creates a payout record for just this commission, with the placeholder Transaction ID single_manual_payout
  • The commission is linked to that payout

When marking as not paid out:

  • Adds commission amount back to partner's outstanding balance
  • Creates a reversal payout record, with a negative amount and the Transaction ID manual_payout_reversal
  • Commission becomes available for future payout again
Balance Impact
Status changes automatically update partner balances. Paid out commissions reduce outstanding balances, while not paid out 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.

  • Checks the required fields (order ID, commission and order total)
  • Shows a success or error notification
  • Stays on the commission page after saving
  • Discard undoes every change since your last save

Commission Status Indicators

View commission information under the page's title:

  • Status: Shows whether the commission has been paid (Paid out/Not paid out)
  • 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 paid out/not paid out switch 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 paid out status carefully, as it impacts financial reporting and partner earnings.

© 2026 Yaplet. All rights reserved.