Generates a revenue report

Use /data/v1/revenue to generate a revenue report. You can apply filters on Date range, Country name, Product Name, and Product path. For each of these filtered variables, you can define the columns to be included and how you would like to group results to generate reports and serve your unique business needs.

Report Columns

These columns can be included in the reportColumns field. Some of these columns can be used to group the data by including column names in the groupBy field.

Column Name	Description	Used to group results (groupBy)
Buyer_Email	Buyer’s email address	Yes
Buyer_ID	Unique ID for the buyer’s orders	Yes
Chargeback_True_False	true - This order was charged backed false - Successful order	Yes
Company_ID	The sellers uniqueID	Yes
Company_Name	The sellers name	Yes
Country_ISO	The 2 Letter ISO country code	Yes
Country_Name	The English name for the country	Yes
Coupon	The coupon code	Yes
Digital_Backup_Fulfillment_Fee	The fee for backup fulfillment	No
Digital_Backup_Fulfillment_Fee_in_USD	The fee for fulfillment convert to USD	No
Digital_Fulfillment_Fee	The fee for fulfillment	No
Digital_Fulfillment_Fee_in_USD	The fee for fulfillment convert to USD	No
Discount	The amount of the discount	Yes
Driving_Offer_Type	The related offer type cross-sell upsell options bundle configuration one_time_fee addon	Yes
Driving_Product_Path	The parent product path	Yes
Fixed_Fee	The fee	No
Fixed_Fee_in_USD	The fee in USD	No
Income	The total for the order including all discounts	Yes
Income_in_USD	The total converted into USD	No
Item_ID	The unique item id	Yes
Order_ID	The unique order id	Yes
Physical_Backup_Fulfillment_Fee	The shipping fee	No
Physical_Backup_Fulfillment_Fee_in_USD	The shipping fee converted to USD	No
Product_Display_Name	The product display name	Yes
Product_ID	The internal product id	Yes
Product_Name	The product name	Yes
Product_Path	The primary key for the product	Yes
Purchase_Type		Yes
Return_Fee	The fee charged for a return	No
Return_Fee_in_USD	The return fee converted to USD	No
Return_True_False	true - this is a return order false - this is a normal order	Yes
Store_Chargeback_Fee	The fee charged for a chargeback	No
Store_ID	The store id	Yes
Store_Name	The Store name	Yes
Subscription_Period	If subscription, the period name	Yes
Subscription_Period_End	If subscription, the end date of the subscription period	No
Subscription_Period_Start	The start date of the subscription period	No
Subscription_Start_Date	The start date of the subscription period	No
Subscription_Status	The current status of this subscription	Yes
Subscription_True_False	true - this is a subscription product false - one-time purchase	Yes
Tax	The tax amount	No
Tax_Fee	The tax fee	No
Tax_Fee_in_USD	Tax fee in USD	No
Tax_in_USD	The tax amount converted into USD	No
Transaction_Amount	The line item amount	No
Transaction_Amount_in_USD	The line item amount converted into USD	No
Transaction_Currency	The currency of the order	Yes
Transaction_Date	The date of the order	Yes
Transaction_Fee	The fee paid for this order	No
Transaction_Fee_in_USD	The fee converted into USD	No
Transaction_Item_Count	The total number of lines on this order	No
Transaction_Month	The month of the transaction (MM)	Yes
Transaction_Rate	The rate of the transaction	No
Transaction_Time_UTC	The time of the order	No
Transaction_Type		Yes
Transaction_Year	The year of the transaction (YYYY)	Yes
Grand_Total_In_USD	The grand total of the whole order in USD	No
syncDate	When reading new data, the last read date. This field can be used to sync up your DB with FastSpring’s data APIs	No
countryISO	The country code in 2 letter ISO format	Yes
Product_Count	The total number of unique products purchased within this order	No
Product_Units	The total number of quantity purchased with this whole order	No