Update Commission Rate

POST

admin

commission-rates

{id}

curl -X POST 'http://localhost:9000/admin/commission-rates/comrate_01HXYZ8Q2M4N6P8R0T2V4W6X8Y' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{"value": 15, "is_enabled": true}'

const { commission_rate } = await client.admin.commissionRates.$id.mutate({
  $id: "comrate_01HXYZ8Q2M4N6P8R0T2V4W6X8Y",
  value: 15,
  is_enabled: true,
})

{
  "commission_rate": {
    "id": "comrate_01HXYZ8Q2M4N6P8R0T2V4W6X8Y",
    "name": "Default",
    "code": "default",
    "type": "percentage",
    "value": 15,
    "is_enabled": true,
    "is_default": true,
    "rules": [],
    "values": []
  }
}

Updates a commission rate’s properties.

Rules are managed separately through the batch rules endpoint.

Path parameters

string

required

The commission rate’s ID.

Body parameters

string

The rate’s display name.

string

Unique code identifying the rate.

string

The rate type: fixed or percentage.

number

The commission value, a percentage or a fixed amount.

string

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.

object[]

Per-currency fixed amounts.

Show properties

string

required

The value’s currency code.

number

required

The fixed commission amount for that currency.

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.

boolean

Whether the rate is active.

object[]

Rules scoping the rate.

object[]

Per-currency fixed amounts.

curl -X POST 'http://localhost:9000/admin/commission-rates/comrate_01HXYZ8Q2M4N6P8R0T2V4W6X8Y' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{"value": 15, "is_enabled": true}'

const { commission_rate } = await client.admin.commissionRates.$id.mutate({
  $id: "comrate_01HXYZ8Q2M4N6P8R0T2V4W6X8Y",
  value: 15,
  is_enabled: true,
})

{
  "commission_rate": {
    "id": "comrate_01HXYZ8Q2M4N6P8R0T2V4W6X8Y",
    "name": "Default",
    "code": "default",
    "type": "percentage",
    "value": 15,
    "is_enabled": true,
    "is_default": true,
    "rules": [],
    "values": []
  }
}

curl -X POST 'http://localhost:9000/admin/commission-rates/comrate_01HXYZ8Q2M4N6P8R0T2V4W6X8Y' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{"value": 15, "is_enabled": true}'

const { commission_rate } = await client.admin.commissionRates.$id.mutate({
  $id: "comrate_01HXYZ8Q2M4N6P8R0T2V4W6X8Y",
  value: 15,
  is_enabled: true,
})

{
  "commission_rate": {
    "id": "comrate_01HXYZ8Q2M4N6P8R0T2V4W6X8Y",
    "name": "Default",
    "code": "default",
    "type": "percentage",
    "value": 15,
    "is_enabled": true,
    "is_default": true,
    "rules": [],
    "values": []
  }
}

Overview

Panel extensions

Admin API

Vendor API

Store API

Configuration

Path parameters

Body parameters

Response

​Path parameters

​Body parameters

​Response

Path parameters

Body parameters

Response