ADM-PAY-103 - Create marketplace commission for supplier

post

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

Creates a marketplace commission rule for a supplier, using supplier externalId.
Only OPERATOR clients are allowed to call this endpoint.
The commission rate is expressed in percent and must follow the defined constraints.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

commissionRate

string

required

Commission rate expressed in percent.
Constraints:
- Must be ≥ 0
- Must be < 100
- Maximum 4 decimals allowed in input
- Stored exactly as decimal (no rounding)
Example: 2.3456% → stored 0.023456

supplierId

string

required

ExternalId of the supplier.
Must reference an existing supplier.
Only externalIds are accepted.

Headers

dj-client

string

enum

required

Specifies the client type making the request.

OPERATOR: Platform operator user.
ACCOUNT: Customer account user.
SUPPLIER: Supplier managing orders.

Allowed:

dj-api-key

string

required

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

dj-store

string

(Optional) Store ID in multi-store environments.

dj-store-view

string

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

Responses

201

Marketplace commission created successfully. No content is returned.

400

Bad request.
Possible errors:
- Missing fields
- Commission out of bounds
- Invalid commission format

401

Unauthorized.

403

Forbidden. Only OPERATOR clients are allowed.

404

Supplier not found.

409

Marketplace commission already exists for this supplier.

500

Internal server error.

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here!