Get Sale(s)
Returns sales for your program. Filter by a single sale with id, by the affiliate who earned it, by the referral it belongs to, or by the IDs the sale has in your own system (saleExternalId and saleExternalInvoiceId). With no parameters, every sale in the program is returned.
Every sale is returned with a commissionEarned field — the commission recorded for the affiliate credited with that sale.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
The numeric sale ID. Returns a single sale.
Return every sale credited to this affiliate UUID.
Return every sale credited to the affiliate with this email address.
Return every sale belonging to this referral UUID.
Return every sale whose externalId matches — the ID of the sale in your own system.
Return every sale whose externalInvoiceId matches — the ID of the invoice in your own system. Useful when you invoice customers on purchase.
Response
A single sale when filtering by id (null if no match), otherwise an array.
- object
- object[]
The sale ID
The affiliate credited with this sale
The referral this sale belongs to
The affiliate program this sale belongs to
The affiliate link the sale was attributed to
The promotional code used on this sale, if any
The ID of this sale in your own system. Unique per program.
The ID of the invoice in your own system. Unique per program.
Name of the customer
Email of the customer
Gross value of the sale
Commission rate applied to this sale
Commission recorded for the credited affiliate. Merged in by the API from the sale's commission record — it is not a column on the sale itself.
Tax deducted before commission was calculated
Shipping deducted before commission was calculated
Product identifiers attached to this sale
Clicks attributed to this sale
Whether the sale is live or has been refunded
ACTIVE, REFUNDED When the sale was marked refunded
What triggered the commission for this sale
SIGNUP, PURCHASE, BONUS, CONTENT_REWARD Where the sale came from. Sales created through this API have API.
UNKNOWN, API, INTEGRATION, MANUAL, IMPORTED, AUTOMATED Arbitrary JSON you can attach to the sale
When the sale was recorded