HomeGuidesAPI ReferenceRelease Notes
Log In
API Reference

ADM-PAY-501

get
https://example.com/v1/payments/marketplace-commissions

Retrieve all marketplace commission rules configured for suppliers.
Only OPERATOR users are allowed.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int32
int32
sort
array of strings
sort
supplierIds
array of strings

Multi-valued filter on supplier external IDs.
Unknown values are silently ignored.

supplierIds
string

Case-insensitive textual filter “contains”.
Invalid values are ignored.

float

Minimum commission rate (inclusive).
Invalid values are ignored.

float

Maximum commission rate (inclusive).
Invalid values are ignored.

status
array of strings

Multi-valued filter on commission rule status.
Unknown values are ignored.

status
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

401

Unauthorized

403

Forbidden for non-operator users.

500

Unexpected internal server error.

Updated 3 months ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago