v1
latestOpenAPI 3.0.12026-08-062532117.6 KBGet 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.
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.