Skip to main content
CommissionsVersion: v3

Create commission

POST/affiliate-manager/{locationId}/commission

Create a manual commission for a customer.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:affiliate-manager.write
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3
Example:v3

Path Parameters

locationIdstringrequired

Location Id

Example:ve9EPM428h8vShlRW1KT

Body

application/json
affiliateIdstringrequired

Affiliate Id

Example:6385d230f6d19db03eef6fb2
campaignIdstringrequired

Campaign Id

Example:6385d230f6d19db03eef6fb3
customerIdstringrequired

Customer Id

Example:6385d230f6d19db03eef6fb4
amountnumberrequired

Amount. Must not be negative.

Possible values: >= 0

Example:100
currencystringrequired

ISO 4217 currency code

Available optionsUSDCADEURAEDAFNALLAMDARSAUDAZNBAMBBD
Example:USD
descriptionstring

Description

Example:Manual commission
eventDatestring<date-time>

Event Date

Example:2023-08-02T00:00:00.000Z
eventIdstring

Event Id

Example:manual-event-123

Response

application/json

Successful response

_idstringrequired

Commission id

Example:6385d230f6d19db03eef6fb2
locationIdstringrequired

Location id the commission belongs to

Example:ve9EPM428h8vShlRW1KT
campaignIdstringrequired

Campaign id

Example:6385d230f6d19db03eef6fb3
affiliateIdstringrequired

Affiliate id

Example:6385d230f6d19db03eef6fb2
customerIdstringrequired

Customer id

Example:6385d230f6d19db03eef6fb4
transactionIdstringrequired

Transaction id. Generated for manual commissions, which have no upstream transaction

Example:6385d230f6d19db03eef6fb5
payoutIdstring

Payout the commission was added to

Example:6385d230f6d19db03eef6fb6
planstring

Product name the commission was earned on

Example:Manual Commission
productIdstringrequired

Product id the commission was earned on. Always "manual" for a manually created commission

Example:manual
qtynumberrequired

Quantity

Example:1
amountnumberrequired

Base amount the commission was calculated on

Example:100
unitDiscountnumber

Unit discount applied before calculating the commission

Example:0
commissionnumber

Configured commission percentage or flat value

Example:25
commissionTypestring

Commission type

Example:percentage
commissionAmountnumber

Calculated commission amount

Example:25
currencystringrequired

Currency

Example:USD
statusstring

Commission Status

Available optionspendingapprovedpaiddenied
Example:approved
payoutAtstring

Month the commission is paid out in

Example:2024-06-01T00:00:00.000Z
dueAtstring

Due date

Example:2024-06-30T00:00:00.000Z
liveModeboolean

Whether the commission is in live mode

Example:true
isTrialboolean

Whether the commission is a trial commission

Example:false
tierstringrequired

Commission tier

Available optionsfirstsecondthirdfourthfifthsixthseventh
Example:first
creationSourcestringrequired

How the commission was created

Available optionsorderinvoicemanualexternal-paymentlead-commissionfirst-promoter
Example:manual
eventIdstring

Event id supplied on the request

Example:manual-event-123
deletedbooleanrequired

Whether the commission is deleted

Example:false
createdByobject

Created by audit metadata

lastUpdatedByobject

Last updated by audit metadata

createdAtstringrequired

Created at timestamp

Example:2024-06-16T00:00:00.000Z
updatedAtstringrequired

Updated at timestamp

Example:2024-06-16T00:00:00.000Z