List Commission Rates

GET

admin

commission-rates

curl 'http://localhost:9000/admin/commission-rates?scope_type=store&limit=20' \
  -H 'Authorization: Bearer <token>'

const { commission_rates, count } = await client.admin.commissionRates.query({
  scope_type: "store",
  limit: 20,
})

{
  "commission_rates": [
    {
      "id": "comrate_01HXYZ8Q2M4N6P8R0T2V4W6X8Y",
      "name": "Default",
      "code": "default",
      "type": "percentage",
      "value": 10,
      "currency_code": null,
      "include_tax": false,
      "include_shipping": false,
      "is_enabled": true,
      "is_default": true,
      "rules": [],
      "values": []
    }
  ],
  "count": 1,
  "offset": 0,
  "limit": 20
}

Returns commission rates with their rules and currency-specific values.

scope_type is a virtual filter derived from each rate’s rules. It is not a stored column. Use it to filter rates by the scope their rules target.

Query parameters

number

default:"50"

Maximum number of records to return.

number

default:"0"

Number of records to skip.

string

Field to sort by, prefix with - for descending order.

string

Comma-separated fields to include in the response.

string

Search term matched against commission rates.

string | string[]

Filter by commission rate ID(s).

string | string[]

Filter by commission rate code(s).

string | string[]

Filter by rate type: fixed or percentage.

string | string[]

Filter by rule scope: store, product_type, category, store_product_type, or store_category.

boolean

Filter by enabled state.

boolean

Filter by whether the rate is the marketplace default.

object

Filter by creation date using operators like $gte and $lte.

object

Filter by update date using operators like $gte and $lte.

Response

object[]

Show properties

string

The commission rate’s ID.

string

The rate’s display name.

string

The rate’s unique code.

string

The rate type: fixed or percentage.

number

The commission value, a percentage or a fixed amount.

string | null

Currency of a fixed rate’s value.

boolean

Whether commission is calculated on tax-inclusive amounts.

boolean

Whether shipping is included in the commission base.

boolean

Whether the rate is active.

boolean

Whether this is the marketplace default rate.

object[]

Rules scoping the rate, each with id, reference, and reference_id.

object[]

Per-currency fixed amounts, each with id, currency_code, and amount.

string

Creation timestamp.

string

Last update timestamp.

number

Total number of matching commission rates.

number

Number of records skipped.

number

Maximum number of records returned.

curl 'http://localhost:9000/admin/commission-rates?scope_type=store&limit=20' \
  -H 'Authorization: Bearer <token>'

const { commission_rates, count } = await client.admin.commissionRates.query({
  scope_type: "store",
  limit: 20,
})

{
  "commission_rates": [
    {
      "id": "comrate_01HXYZ8Q2M4N6P8R0T2V4W6X8Y",
      "name": "Default",
      "code": "default",
      "type": "percentage",
      "value": 10,
      "currency_code": null,
      "include_tax": false,
      "include_shipping": false,
      "is_enabled": true,
      "is_default": true,
      "rules": [],
      "values": []
    }
  ],
  "count": 1,
  "offset": 0,
  "limit": 20
}

curl 'http://localhost:9000/admin/commission-rates?scope_type=store&limit=20' \
  -H 'Authorization: Bearer <token>'

const { commission_rates, count } = await client.admin.commissionRates.query({
  scope_type: "store",
  limit: 20,
})

{
  "commission_rates": [
    {
      "id": "comrate_01HXYZ8Q2M4N6P8R0T2V4W6X8Y",
      "name": "Default",
      "code": "default",
      "type": "percentage",
      "value": 10,
      "currency_code": null,
      "include_tax": false,
      "include_shipping": false,
      "is_enabled": true,
      "is_default": true,
      "rules": [],
      "values": []
    }
  ],
  "count": 1,
  "offset": 0,
  "limit": 20
}

Overview

Panel extensions

Admin API

Vendor API

Store API

Configuration

Query parameters

Response

​Query parameters

​Response

Query parameters

Response