Updates a commission rate

Update a commission rate.

put

Path parameters

idstringRequired

The id of the commission rate.

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Auth-KeystringRequired

Auth-Key is required to authenticate the request. If missing, the server will return 401 Unauthorized.

Example: YOUR_AUTH_KEY

Body

application/jsontext/jsonapplication/*+json

This class represents the commission rate command request DTO.

typestring · enumOptional

Provides all the types related to CommissionRate.

Possible values:

unitstring · min: 1Required

The unit of the commission rate.

quantityFrominteger · int32 · nullableOptional

The quantity from.

quantityTointeger · int32 · nullableOptional

The quantity to.

percentagenumber · doubleRequired

The percentage.

descriptionstring · nullableOptional

The description.

isDefaultbooleanOptional

The default commission rate. By default, it is set to false.

Responses

200

The request was successful.

application/json

The API result model with data.

successbooleanRead-onlyRequired

This is the flag to indicate whether the API call is successful or not.

statusCodeinteger · int32Read-onlyRequired

This is the HTTP status code. This is used to determine the status code to be returned to the client.

messagestring · min: 1Required

This is the message to be displayed to the user.

databooleanOptional

401

The user is not authorized to access the requested resource. The request is missing the required Auth-Key header.

application/json

403

The user's access was denied.

application/json

404

The user was not found in the system.

application/json

429

API call exceeded rate limit due to too many requests.

application/json

put

/api/v1/commission-rates/{id}

HTTPcURLJavaScriptPython

PUT /api/v1/commission-rates/{id} HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 118

{
  "type": "Discount",
  "unit": "text",
  "quantityFrom": 1,
  "quantityTo": 1,
  "percentage": 1,
  "description": "text",
  "isDefault": true
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": true,
  "errors": []
}