Sale Endpoints
Create a Sale
Sale Endpoints
Create a Sale
Creates a new sale under the specified affiliate program. Note: a referral and affiliate are required to create a Sale.
POST
/
sales
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
referralId
string
requiredThe referral ID associated with the sale
name
string
requiredName of the sale
email
string
requiredEmail associated with the sale
totalEarned
number
requiredTotal amount earned from the sale
externalId
string
The external ID of the sale
externalInvoiceId
string
The external invoice ID of the sale
commissionRate
number
Commission rate for the sale
Response
200 - application/json
id
integer
The sale ID
affiliateId
string
The affiliate ID associated with the sale
referralId
string
The referral ID associated with the sale
externalId
string
The external ID of the sale
externalInvoiceId
string
The external invoice ID of the sale
name
string
Name of the sale
email
string
Email associated with the sale
totalEarned
number
Total amount earned from the sale
commissionRate
number
Commission rate for the sale
createdAt
string
Creation timestamp of the sale