HomeGuidesAPI ReferenceRelease Notes
Log In
API Reference

ADM-SETTINGS-204 - Update platform payment commissions

put
https://example.com/v1/settings/payment-commissions

Updates the platform payment commissions.
For now, only defaultRate of the commission model is used; tiers is stored but ignored.
This endpoint is restricted to OPERATOR users and must not be exposed to customer users or suppliers.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
number
required

Global platform commission rate stored as a decimal (0 < rate < 1)

Headers
string
enum
required

Specifies the client type making the request.

  • OPERATOR: Platform operator user.

  • ACCOUNT: Customer account user.

  • SUPPLIER: Supplier managing orders.

Allowed:
string
required

API key required for authentication. Must be valid and linked to the requesting user.

string

(Optional) Store ID in multi-store environments.

string

(Optional) Store view ID in multi-store environments.

Responses
204

Settings updated successfully.

400

Invalid request payload.

403

Forbidden - only OPERATOR can update settings.

500

Unexpected internal server error.

Updated 8 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here!

Updated 8 months ago

Did this page help you?