Skip to main content
POST
/
admin
/
commission-rates
curl -X POST 'http://localhost:9000/admin/commission-rates' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{"name": "Electronics", "code": "electronics", "type": "percentage", "value": 12, "rules": [{"reference": "product_category", "reference_id": "pcat_01HXYZ"}]}'

{
  "commission_rate": {
    "id": "comrate_01HXYZ8Q2M4N6P8R0T2V4W6X8Y",
    "name": "Electronics",
    "code": "electronics",
    "type": "percentage",
    "value": 12,
    "currency_code": null,
    "include_tax": false,
    "include_shipping": false,
    "is_enabled": true,
    "is_default": false,
    "rules": [
      {
        "id": "comrule_01HXYZ9A1B2C3D4E5F6G7H8J9K",
        "reference": "product_category",
        "reference_id": "pcat_01HXYZ"
      }
    ],
    "values": []
  }
}
Creates a commission rate, optionally with scoping rules and per-currency values.

​
Body parameters

​
name
string
required
The rate’s display name.
​
code
string
required
Unique code identifying the rate.
​
type
string
required
The rate type: fixed or percentage.
​
value
number
required
The commission value — a percentage or a fixed amount.
​
currency_code
string
Currency of a fixed rate’s value.
​
include_tax
boolean
Whether commission is calculated on tax-inclusive amounts.
​
include_shipping
boolean
Whether shipping is included in the commission base.
​
is_enabled
boolean
Whether the rate is active.
​
is_default
boolean
Whether this is the marketplace default rate.
​
rules
object[]
Rules scoping which sellers or products the rate applies to.
​
values
object[]
Per-currency fixed amounts.

​
Response

​
commission_rate
object
curl -X POST 'http://localhost:9000/admin/commission-rates' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{"name": "Electronics", "code": "electronics", "type": "percentage", "value": 12, "rules": [{"reference": "product_category", "reference_id": "pcat_01HXYZ"}]}'

{
  "commission_rate": {
    "id": "comrate_01HXYZ8Q2M4N6P8R0T2V4W6X8Y",
    "name": "Electronics",
    "code": "electronics",
    "type": "percentage",
    "value": 12,
    "currency_code": null,
    "include_tax": false,
    "include_shipping": false,
    "is_enabled": true,
    "is_default": false,
    "rules": [
      {
        "id": "comrule_01HXYZ9A1B2C3D4E5F6G7H8J9K",
        "reference": "product_category",
        "reference_id": "pcat_01HXYZ"
      }
    ],
    "values": []
  }
}