Usage
All administrator pages are under Vendors → Commission rules, with four tabs: Rules, Simulator, Report and Recalculate orders.
Click + on the Rules tab to add a rule.
General
Section titled “General”- Name: shown in the admin pages, the report and on the vendors’ My commission rates page. Do not put internal notes in it.
- Priority: a number; lower numbers come first. See which rule applies.
- Status: Active or Disabled. A disabled rule is ignored.
Conditions
Section titled “Conditions”A rule applies only when all its conditions match. Leave a condition empty to ignore it. A rule with no conditions applies to every product of every vendor.
| Condition | Matches when |
|---|---|
| Vendors | The order belongs to one of the selected vendors. |
| Vendor plans | The vendor’s plan (the plan stored on the payout) is one of the selected plans. |
| Categories | The product is assigned to one of the categories (main or additional category). With Include subcategories, products in any subcategory match too. |
| Products | The product is one of the selected products. A common (master) product also matches the vendors’ offers of it, and a parent variation matches its variations. |
| Product price | The unit price the customer paid is within the range. |
| Order subtotal | The subtotal of the vendor order (products only) is within the range. |
| Vendor sales this month | The total of the vendor’s orders placed earlier in the same calendar month, in order statuses that count for payouts (Settings of order statuses: Calculate for payouts), is within the range. Use it for volume tiers (for example 10% below $5,000 and 8% from $5,000). |
| Order date | The order was placed between the two dates (inclusive; the store time zone). Use it for promotional periods. Rules whose end date has passed are shown as Expired, future ones as Scheduled. |
Ranges are inclusive. 0 or empty means “no limit” on that side.
Commission
Section titled “Commission”- Percent of the base: percent of the commission base of the products the rule applies to.
- Fixed amount per order: added once per vendor order when the rule applies to at least one product.
- Minimum / maximum commission per order: limits the commission of this rule within one vendor order (percent part + fixed amount). If several rules apply to one order, each rule is limited separately.
A rule needs a percent, a fixed amount or a minimum commission.
Commission base
Section titled “Commission base”| Field | Values |
|---|---|
| Include shipping | Vendor plans setting (default), Yes, No. Shipping is shared between the products of the order by their subtotal. |
| Include taxes | Vendor plans setting (default), Yes, No. With No, taxes included in prices are taken out of the base and taxes added on top are not added. |
| Discounts | Add-on setting (default), After discounts (price paid), Before discounts (list price). The order discount is shared between the products by their subtotal. |
How the commission is calculated
Section titled “How the commission is calculated”- When a vendor order is placed, the core (Vendor plans, and Commissions by category if active) calculates its commission as usual.
- The add-on then looks at every product of the order and picks one rule for it (see below). Products without a matching rule keep the core rate: the plan percent, or the category rate when Vendor plans: Commissions by category is active.
- For each rule:
commission = sum of the bases of its products × percent + fixed amount, then the minimum/maximum is applied. - Products without a rule:
sum of their bases × their core rate + the plan fixed fee. - The order commission is the sum of all parts, plus the payment surcharge if the core charges it to the vendor (unchanged), and never more than the order total.
- If no product matches a rule, the payout is left exactly as the core calculated it.
The vendor payout (Accounting) stores the result: the vendor balance grows by order total − commission, and the administrator’s income is the commission. With Collect taxes from vendors, the vendor tax part is added on top exactly as in the core.
A rule replaces the plan commission for the products it matches, including the plan’s fixed fee: the plan fixed fee is charged only when at least one product of the order has no rule.
Which rule applies
Section titled “Which rule applies”The most specific rule wins (default). Every condition adds to the rule’s specificity:
| Condition | Points |
|---|---|
| Products | 32 |
| Categories | 16 |
| Vendors | 8 |
| Vendor plans | 4 |
| Product price | 2 |
| Order subtotal, vendor sales this month, order date | 1 each |
The matching rule with the most points wins; on a tie, the lower priority number; then the older rule. Example: an “Apparel 12%” category rule (16) beats an “ACME Corp 8%” vendor rule (8) for an ACME Corp jacket, while ACME Corp’s electronics get 8%. The specificity is shown in the rule list and in the simulator.
The rule with the lowest priority number wins: the rules are a first-match list ordered by priority (then by age), regardless of their conditions.
Order edits, refunds and status changes
Section titled “Order edits, refunds and status changes”- Order status changes (cancelled, declined, etc.) work as in the core: the payout stays, and the order is counted in the balance only in statuses that are calculated for payouts.
- Edited orders (admin order editing): for orders whose commission was calculated by rules, the add-on recalculates the commission of the whole edited order (rules evaluated at the original order date) and the core Order changed entry gets the difference to what was charged before. Orders calculated by the core stay with the core logic.
- Refunds (RMA returns with refund): for orders calculated by rules, the commission is returned at the order’s effective rate (commission ÷ order total) for the refunded amount; when the whole order is refunded, everything charged is returned.
Existing orders
Section titled “Existing orders”Rules never change orders that were already placed: creating, editing, disabling or deleting a rule affects new orders only. Use Recalculate orders to apply the current rules to earlier orders on purpose.
Simulator
Section titled “Simulator”Simulator tab: pick a product, optionally another vendor, unit price, quantity, order subtotal, shipping cost and order date, and click Calculate. You see:
- the commission with rules, what the plan alone would charge, and what the vendor receives;
- every matching rule, with the applied one highlighted, its priority and specificity;
- the calculation per rule and product.
Taxes are not simulated, and nothing is saved. The vendor’s sales this month are read from the real orders.
Order page
Section titled “Order page”Vendor orders get a Marketplace commission block under the totals (admin, and the vendor panel if enabled): all payout entries of the order with the commission charged and what the plan would have charged, and the latest calculation per rule and product. The Accounting page shows “Commission rules, effective rate x%” under the transaction type of rule-based entries.
Report
Section titled “Report”Report tab: every payout entry calculated by rules (order placed, order changed, refund, recalculation), filterable by vendor, rule and period, with totals of the rule commission and of what the plan alone would have charged. Export CSV downloads the filtered list (date, order, vendor, entry, rules, order amount, base, plan commission, rule commission, difference).
Recalculate orders
Section titled “Recalculate orders”Recalculate orders tab:
- Enter order IDs, or a date range, optionally with a vendor, and click Preview. Only vendor orders that have an Order placed payout are included (up to 500 per run).
- The preview lists what was charged so far, the commission with the current rules (rules evaluated at each order’s date, on the current order contents), and the difference.
- Click Apply recalculation. Every order with a difference gets one Order changed entry in Accounting with order amount 0 and the commission difference, with the comment “Commission recalculated with the current commission rules”. Earlier entries are not rewritten, and the vendor balance changes by the difference.
Running it again on the same orders changes nothing (the difference is 0).
Vendor panel: My commission rates
Section titled “Vendor panel: My commission rates”Vendors see their plan, the plan commission (and category rates of their plan if Commissions by category is active), and the active rules that can apply to them: name, conditions, rate, base and state. Rules limited to other vendors or other plans and expired rules are not shown; the vendor list of a rule is shown as “Your store”.