Updates a commission rate | Jframework

Update a commission rate.

put

Path parameters

idstringRequired

The id of the commission rate.

Query parameters

api-versionstringOptional

Header parameters

BrandUrlstringRequired

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

Example: YOUR_BRAND_URL

AuthkeystringRequired

This is used to authenticate the request. If the request is not authenticated, the server will return a 401 Unauthorized response.

Example: YOUR_AUTH_KEY

Body

This class represents the commission rate create request DTO.

typestring · enumOptionalPossible values:

unitstring | nullableOptional

The unit of the commission rate.

quantityFrominteger · int32 | nullableOptional

The quantity from.

quantityTointeger · int32 | nullableOptional

The quantity to.

percentagenumber · double | nullableOptional

The percentage.

descriptionstring | nullableOptional

The description.

isDefaultboolean | nullableOptional

The default commission rate.

Responses

200

The request was successful.

application/json

401

The user is not authorized to access the requested resource. The request is missing the required AuthKey header.

application/json

403

The user's access was denied.

application/json

404

The user was not found in the database.

application/json

429

The user has exceeded the rate limit.

application/json

put

PUT /api/v1/commission-rates/{id} HTTP/1.1
Host: protocol.jframework.dev
BrandUrl: text
Authkey: text
Content-Type: application/json
Accept: */*
Content-Length: 122

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

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