PUT
/
apps
/
{app_id}
/
merchants
/
{merchant_id}
/
commission_rate
curl --request PUT \
  --url https://sandbox-api.violet.io/v1/apps/{app_id}/merchants/{merchant_id}/commission_rate \
  --header 'Content-Type: application/json' \
  --data '{
  "commission_rate": 123,
  "commission_locked": true
}'
{
  "id": 123,
  "app_id": 123,
  "merchant_id": 123,
  "scope": "<string>",
  "status": "REQUESTED",
  "install_source": "DIRECT",
  "commission_rate": 123,
  "commission_locked": true,
  "date_created": "2023-11-07T05:31:56Z",
  "date_last_modified": "2023-11-07T05:31:56Z"
}

The maximum allowed commission rate that can be set by a channel is 50, while a merchant can set any value up to 100.

Headers

X-Violet-Token
string
X-Violet-App-Secret
string
X-Violet-App-Id
integer

Path Parameters

app_id
integer
required
merchant_id
integer
required

Body

application/json
commission_rate
number

Custom commission rate between the channel and supplier.

commission_locked
boolean

Indicates if the commission rate is locked or not. Commission rates can only be locked or unlocked by a Channel.

Response

default - application/json
id
integer
app_id
integer
required

App ID

merchant_id
integer
required

Merchant ID

scope
string

Scope

status
enum<string>

Status

Available options:
REQUESTED,
CONNECTED,
NOT_CONNECTED,
DECLINED
install_source
enum<string>

Source of the App Install

Available options:
DIRECT,
CATEGORY,
APP_AGREEMENT
commission_rate
number

Custom commission rate between the channel and supplier.

commission_locked
boolean

Indicates if the commission rate is locked or not. Commission rates can only be locked or unlocked by a Channel.

date_created
string

Date of creation

date_last_modified
string

Date of last update

Was this page helpful?

App Request Merchant App UninstallGet Connection Health