Get commission rates

Get commission rates

get

Query parameters

TypestringOptional

Filter by type. The type can be one of the following: Discount, Commission.

UnitstringOptional

The unit of the commission rate.

IsDefaultbooleanOptional

The default commission rate.

SortDataFieldstringOptional

The sort data field of the pagination.

SortOrderstringOptional

The sort order of the pagination.

PageNumberinteger · int32Optional

The page number of the pagination. Default value is 0.

PageSizeinteger · int32Optional

The page size of the pagination. Default value is 200.

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

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

429

The user has exceeded the rate limit.

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/commission-rates HTTP/1.1
Host: protocol.jframework.dev
BrandUrl: text
Authkey: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": [
    {
      "brandCode": "BRAND-CODE",
      "user": {
        "code": "EXAMPLE",
        "avatar": "https://www.gravatar.com/avatar/205e460b479e2e5b48aec07710c08d50",
        "packageId": "1Plamxinzg18snza",
        "packageCode": "PACKAGE",
        "emailAddress": "[e-mail]",
        "nickName": "example",
        "roles": [
          "admin",
          "support"
        ],
        "id": "Plamxinzg18snza"
      },
      "type": "Discount",
      "unit": "unit",
      "quantityFrom": 1,
      "quantityTo": 10,
      "percentage": 10,
      "description": "description",
      "isDefault": true,
      "id": "sApKpllz4sAplsmzha"
    }
  ],
  "errors": []
}