Create commission

POST 
/affiliate-manager/:locationId/commission

Create a manual commission for a customer.

Request

Version stringrequired

API Version

Available optionsv3

locationId stringrequired

Location Id

application/json

application/json

Body

Bodyrequired

affiliateIdstringrequired

Affiliate Id

campaignIdstringrequired

Campaign Id

customerIdstringrequired

Customer Id

amountnumberrequired

Amount. Must not be negative.

Possible values: >= 0

currencystringrequired
ISO 4217 currency code
Available optionsUSDCADEURAEDAFNALLAMDARSAUDAZNBAMBBD
descriptionstring

Description

eventDatestring<date-time>

Event Date

eventIdstring

Event Id

Example (auto)

{
  "affiliateId": "6385d230f6d19db03eef6fb2",
  "campaignId": "6385d230f6d19db03eef6fb3",
  "customerId": "6385d230f6d19db03eef6fb4",
  "amount": 100,
  "currency": "USD",
  "description": "Manual commission",
  "eventDate": "2023-08-02T00:00:00.000Z",
  "eventId": "manual-event-123"
}

application/json

Successful response

application/json

Schema

Schema

_idstringrequired

Commission id

locationIdstringrequired

Location id the commission belongs to

campaignIdstringrequired

Campaign id

affiliateIdstringrequired

Affiliate id

customerIdstringrequired

Customer id

transactionIdstringrequired

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

payoutIdstring

Payout the commission was added to

planstring

Product name the commission was earned on

productIdstringrequired

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

qtynumberrequired

Quantity

amountnumberrequired

Base amount the commission was calculated on

unitDiscountnumber

Unit discount applied before calculating the commission

commissionnumber

Configured commission percentage or flat value

commissionTypestring

Commission type

commissionAmountnumber

Calculated commission amount

currencystringrequired

Currency

statusstring
Commission Status
Available optionspendingapprovedpaiddenied
payoutAtstring

Month the commission is paid out in

dueAtstring

Due date

liveModeboolean

Whether the commission is in live mode

isTrialboolean

Whether the commission is a trial commission

tierstringrequired
Commission tier
Available optionsfirstsecondthirdfourthfifthsixthseventh
creationSourcestringrequired
How the commission was created
Available optionsorderinvoicemanualexternal-paymentlead-commissionfirst-promoter
eventIdstring

Event id supplied on the request

deletedbooleanrequired

Whether the commission is deleted

createdByobject

Created by audit metadata

lastUpdatedByobject

Last updated by audit metadata

createdAtstringrequired

Created at timestamp

updatedAtstringrequired

Updated at timestamp

Example (auto)

{
  "_id": "6385d230f6d19db03eef6fb2",
  "locationId": "ve9EPM428h8vShlRW1KT",
  "campaignId": "6385d230f6d19db03eef6fb3",
  "affiliateId": "6385d230f6d19db03eef6fb2",
  "customerId": "6385d230f6d19db03eef6fb4",
  "transactionId": "6385d230f6d19db03eef6fb5",
  "payoutId": "6385d230f6d19db03eef6fb6",
  "plan": "Manual Commission",
  "productId": "manual",
  "qty": 1,
  "amount": 100,
  "unitDiscount": 0,
  "commission": 25,
  "commissionType": "percentage",
  "commissionAmount": 25,
  "currency": "USD",
  "status": "approved",
  "payoutAt": "2024-06-01T00:00:00.000Z",
  "dueAt": "2024-06-30T00:00:00.000Z",
  "liveMode": true,
  "isTrial": false,
  "tier": "first",
  "creationSource": "manual",
  "eventId": "manual-event-123",
  "deleted": false,
  "createdBy": {
    "source": "INTEGRATION",
    "channel": "OAUTH",
    "sourceId": "6385d230f6d19db03eef6fb7",
    "sourceName": "Marketplace App"
  },
  "lastUpdatedBy": {
    "source": "INTEGRATION",
    "channel": "OAUTH",
    "sourceId": "6385d230f6d19db03eef6fb7",
    "sourceName": "Marketplace App"
  },
  "createdAt": "2024-06-16T00:00:00.000Z",
  "updatedAt": "2024-06-16T00:00:00.000Z"
}