Create Commission

Creates a sales commission rule (percent of sale, fixed value, or percent of margin) applying to all products or to selected categories, for all employees or selected employees. Requires the p/manage-commissions permission — the standard app role does not include it, so this operation is documented from code and returns 403 FORBIDDEN without that permission.

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

Greater than 0; under 100 when type is percent.

string
enum
required
Allowed:
string
enum
required
Allowed:
categories
array

Category ids — required when filter_type is category.

categories
string
enum
required

With select, assign employees via the set-employees endpoint.

Allowed:
Headers
string
required

The merchant install this request acts on (install.store_id from the app.installed webhook).

Responses

403

Missing the p/manage-commissions permission.

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