Update Sale
Updates a sale identified by saleId, and fires the sale.updated webhook.
commissionEarned is handled separately from the other fields: it updates the commission record for the affiliate credited with the sale, not the sale itself. Every other field you send is applied directly to the sale, so sending a field that is not listed below will fail the request.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Fields to update
The sale to update
Name of the customer
Email of the customer
Gross value of the sale
Commission rate recorded on the sale
Sets the commission recorded for the credited affiliate. Applied to the commission record rather than the sale.
The ID of this sale in your own system
The ID of the invoice in your own system
Arbitrary JSON to attach to the sale
Response
The updated sale, including its recalculated commissionEarned.
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