Sale Endpoints
Get Sale(s)
Sale Endpoints
Get Sale(s)
Returns a list of sales based on the affiliate program, filtered by optional sale ID, affiliate ID, affiliate email, referral ID, or external ID
GET
/
sales
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
id
integer
The ID of the sale to retrieve
affiliateId
string
The affiliate ID associated with the sale
affiliateEmail
string
The email of the affiliate associated with the sale
referralId
string
The referral ID associated with the sale
saleExternalId
string
The external ID of 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