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

{
  "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

​
limit
number
default:"50"
Maximum number of records to return.
​
offset
number
default:"0"
Number of records to skip.
​
order
string
Field to sort by, prefix with - for descending order.
​
fields
string
Comma-separated fields to include in the response.
​
q
string
Search term matched against commission rates.
​
id
string | string[]
Filter by commission rate ID(s).
​
code
string | string[]
Filter by commission rate code(s).
​
type
string | string[]
Filter by rate type: fixed or percentage.
​
scope_type
string | string[]
Filter by rule scope: store, product_type, category, store_product_type, or store_category.
​
is_enabled
boolean
Filter by enabled state.
​
is_default
boolean
Filter by whether the rate is the marketplace default.
​
created_at
object
Filter by creation date using operators like $gte and $lte.
​
updated_at
object
Filter by update date using operators like $gte and $lte.

​
Response

​
commission_rates
object[]
​
count
number
Total number of matching commission rates.
​
offset
number
Number of records skipped.
​
limit
number
Maximum number of records returned.
curl 'http://localhost:9000/admin/commission-rates?scope_type=store&limit=20' \
  -H 'Authorization: Bearer <token>'

{
  "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
}