Create a commission rate

Run the workflow

src/api/custom/route.ts

import type { MedusaRequest, MedusaResponse } from "@medusajs/framework/http"
import { createCommissionRatesWorkflow } from "@mercurjs/core/workflows"
import { CommissionRateType } from "@mercurjs/types"

export async function POST(req: MedusaRequest, res: MedusaResponse) {
  const { result } = await createCommissionRatesWorkflow(req.scope).run({
    input: [
      {
        name: "Standard",
        type: CommissionRateType.PERCENTAGE,
        value: 10,
      },
    ],
  })

  res.status(201).json({ commission_rate: result[0] })
}

The workflow takes an array of rates and returns the created records. When you omit code, the module generates a unique one from name.

Create a fixed, per-currency rate

For a flat fee, use CommissionRateType.FIXED and pass per-currency values. The scalar value is the fallback when no currency matches.

await createCommissionRatesWorkflow(req.scope).run({
  input: [
    {
      name: "Flat fee",
      type: CommissionRateType.FIXED,
      value: 5,
      values: [
        { currency_code: "usd", amount: 5 },
        { currency_code: "eur", amount: 4 },
      ],
    },
  ],
})

Scope the rate

A rate created without rules is a catch-all. To scope it to part of the catalog, attach rules with batchCommissionRulesWorkflow.

Only the global rate (is_default) may commission shipping. To let the global rate take a cut of shipping, update it with include_shipping: true via updateCommissionRatesWorkflow.

Store

Catalog

Offer

Attribute

Product Edit

Order Group

Commission

Payout

Review

Run the workflow

Create a fixed, per-currency rate

Scope the rate

​Run the workflow

​Create a fixed, per-currency rate

​Scope the rate

Run the workflow

Create a fixed, per-currency rate

Scope the rate