Skip to main content

Conversion

A Conversion

Fields

FieldTypeAvailabilityNotes
idInt!The record's Refersion id.
createdStringUnix timestamp in seconds, not an ISO 8601 date.
statusStringOne of APPROVED, PENDING, DENIED, UNQUALIFIED. Archived conversions are never returned, whatever you filter on.
denied_reason_codeStringWhy the conversion was denied. Empty unless status is DENIED.
typeStringHow the conversion was attributed, for example AFFILIATE_SITE_CONVERSION for one driven by a tracking link.
is_recurringBooleanTrue when the conversion came from a recurring order rather than a first purchase.
total_itemsIntNumber of line items on the order.
totalStringThe order total, as a decimal string.
commission_totalStringThe commission earned on the order, as a decimal string.
commissionable_amountStringThe portion of the order the commission was calculated against, as a decimal string.
currencyStringISO 4217 currency code.
is_test_conversionBooleanTrue for conversions created by test traffic.
payment_statusStringPAID once the conversion has been included in a payment, UNPAID before that. Derived, not stored.
updatedStringUnix timestamp in seconds, not an ISO 8601 date.
customer_nameStringMerchant tokens always receive this. Marketplace tokens receive it only when the merchant has turned on customer-name sharing for affiliates; otherwise it is an empty string.
customer_emailStringMerchant tokens always receive this. Marketplace tokens receive it only when the merchant has turned on customer-info sharing for affiliates; otherwise it is an empty string.
affiliate_idInt!The affiliate the record belongs to.
offer_idIntThe offer the record is tied to.
payment_idIntThe payment the conversion was included in, or 0 if it has not been paid yet.
order_idStringThe order identifier you sent when you reported the order.
subscription_idStringThe subscription identifier you sent when you reported the order.
reasonString
notesString
product_names[String]The names of the SKUs recorded against the conversion.
affiliateAffiliate
clickClick
shopShop
offerOffer
paymentPayment
products[Product]
coupon_codeStringMerchant tokens onlyThe coupon that triggered the conversion, when it was a coupon conversion.

Sorting

sort accepts id, created, status, type on this type, and sorts descending. Any other value is ignored without an error.

Referenced by