Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
Sale details
Total amount earned from the sale
The referral ID, or affiliate link or affiliate ID associated with the sale (required if email and promoCode are not provided)
Email associated with the sale (required if referralId and promoCode are not provided)
The promotional code associated with an affiliate (required if referralId and email are not provided). When used, the promo code will be validated and its redemption count will be incremented.
Name of the customer (required if not found via referralId or email)
The external ID of the sale
The external invoice ID of the sale
Commission rate for the sale (optional, defaults to affiliate's commission rate)
Response
Sale created successfully
The sale ID
The affiliate ID associated with the sale
The referral ID associated with the sale
The external ID of the sale
The external invoice ID of the sale
Name of the sale
Email associated with the sale
Total amount earned from the sale
Commission rate for the sale
Creation timestamp of the sale