Collapse Menu
Docs Home
Developer Tools
Contact Support

Data Exports

Overview

Access and run data exports.

Use Data Exports for information that is not available in Orders, Subscriptions, or Events reports.

Export Data

  1. In the FastSpring App, navigate to Reports > Data Exports.
  2. Click Create Data Export to open the Create Data Export page.
  3. In the Name field, enter a name to distinguish the export in the list of historical exports.
  4. In the Date and Number Formatting drop-down, select a country for your preferred formatting of dates and numbers.
    • For example: If you select English, dates will be expressed as MM/DD/YYYY and decimals will be expressed using periods (e.g., $123.45). If you select German, dates will be expressed as DD/MM/YYYY and decimals will be expressed using the comma separator (e.g., $123,45).
  5. In the Site field, select the Store whose data you want to export.
  6. In the Date Range From and To drop-downs, select the time frame of activity to include. All dates in the FastSpring App are based on UTC/GMT - 0.
  7. In the Report Type drop-down, select the type of data that you want to export.
    • A variety of pre-defined exports are available to run based on the selected Date Range.
    • The Order Reports - Custom (CSV) and Order Reports - Custom (Text) sections show custom data exports that you previously created in your Store and did not delete.
  8. Click Create.
  9. The page will refresh to the list of Available Data Exports with a message that your new export is processing. The page will automatically refresh every 20 seconds until your export is ready.

After your new export is ready, use the buttons in the Actions column to download, preview on your screen, or permanently delete any export in the list. You can also mouse over the i icon to the right of each export Description to see which user created the export and when the user created it.

Chargeback Ratio Report

Follow instructions to export data and select Order Item Export (CSV) in the Report Type drop-down.

The report includes granular details about Purchase events, Return events, and Return-Dispute events.
Chargebacks that have been completed in our system are listed as Return-Dispute events.

Custom Data Export

For advanced users, use New CSV Template or New Text Template to create a custom data export with more control over exactly which fields or columns appear in your export.

The following example applies to the New CSV Template option but the process is similar for both CSV and Text Templates.

  1. Follow instructions to export data and select New CSV Template in the Report Type drop-down.
  2. In the Custom Report CSV Columns field, enter a column heading for each data point you want to include in the export, separated by commas.
    • For example: If you want to include the order reference, order date, local currency amount for the order, and the USD amount for the order, enter the following:
      Custom Report CSV Columns example
      	Reference,Date,,Amount,Amount(USD)
      

       Regarding #{order.created}

      If you select English for the Date and Number Formatting field and you need to use the #{order.created} variable to insert the order date, include two commas after the column heading rather than one. In the output, the year will be in a separate column, and the extra comma in the list of headings allows everything to be properly aligned.
  3. In the text area labeled Custom Report Template, specify the object name of each data point to include in the export, separated by commas.
    • Use the "order" hyperlink located just below the text area to open a Help window with a list of available order attributes.
  4. To continue the example above, you would enter the following:
    Custom Report Template example
    	#{order.id},#{order.created},#{order.subTotal},#{order.subTotalUSD} 
    Remember to press ENTER at the end of your line of column variables to move your cursor down to the next line so the system knows the last column in the row has been reached.
  5. Click Create.

Exposed Parameters:

Below are lists of all parameters exposed to you for Order Items, Subscriptions, and Variables.

Order Items

  • accountUrl - #{order.accountUrl}
  • activeReview - #{order.activeReview}
  • address - #{order.address.___}
    • address1 - #{order.address.address1}
    • address2 - #{order.address.address2}
    • city - #{order.address.city}
    • country - #{order.address.country}
    • countryDisplay - #{order.address.countryDisplay}
    • postalCode - #{order.address.postalCode}
    • region - #{order.address.region}
    • regionDisplay - #{order.address.regionDisplay}
  • allItems -  all order items
    <repeat value="#{order.allItems}" var="orderItem">
      #{orderItem.___}
    </repeat>
  • allProductNames - all product names
    <repeat value="#{order.allProductNames}" var="value">
      #{value}
    </repeat>
  • baseItems - base order items
  • <repeat value="#{order.baseItems}" var="orderItem">
      #{orderItem.___}
    </repeat>
  • baseProductNames - all base item product names
  • <repeat value="#{order.baseProductNames}" var="value">
      #{value}
    </repeat>
  • billDescriptor - #{order.billDescriptor}
  • coupons - list of all coupons used for any cross-sells and promotional price offers on the order
    <repeat value="#{order.coupons}" var="value">
      #{value}
    </repeat>
  • created - #{order.created}
  • currency - #{order.currency}
    • ISO 3 letter currency code of all monetary values within the order.
  • customList - #{order.customList}
  • customTagsList - #{order.customTagsList}
    • list of order level custom tags/attributes key=value comma separated
  • customer - #{order.customer.___}
    • customer contact information for the order
  • customerReference - #{order.customerReference}
  • discountTotal - #{order.discountTotal}
  • discountTotalUSD - #{order.discountTotalUSD}
    • USD total of discounts applied, if any
  • due - #{order.due}
    • payment due date
  • hasActiveReview - #{order.hasActiveReview}
  • hasCustomTagsJson - #{order.hasCustomTagsJson}
  • hasEmailFulfillment - #{order.hasEmailFulfillment}
  • hasPayPalPayment - #{order.hasPayPalPayment}
  • hasSource - #{order.hasSource}
    • true if source information is available.
  • hasSurveyFields - #{order.hasSurveyFields}
    • true if the order has survey fields.
  • hasTax - #{order.hasTax}
    • true if tax was charged on the order.
  • hasUSTax - #{order.hasUSTax}
    • true if the tax represents U.S. sales tax.
  • hasVAT - #{order.hasVAT}
    • true if the tax represents VAT tax.
  • httpReferrer - #{order.httpReferrer}
  • Id - #{order.id}
  • isEmbedded - #{order.isEmbedded}
  • isFree - #{order.isFree}
  • isGift - #{order.isGift}
  • isProcessing - #{order.isProcessing}
    • true if the order is processing -- the order is accepted, but not yet completed.
  • isRebill - #{order.isRebill}
    • true if it's a recurring charge triggered by a subscription.
  • isReturned - #{order.isReturned}
    • true if order has been fully returned.
  • isTest - #{order.isTest}
    • true if the order is a test.
  • language - #{order.language}
    • ISO language code.
  • notify - #{order.notify.___}
    • Contact information for the party receiving emails about the order.
  • offerNames - List of all offer names that were part of the order. This includes the names of any cross-sells and promotional price offers.
    <repeat value="#{order.offerNames}" var="value">
    #{value}
    </repeat>
  • originIp - #{order.originIp}
    • IP address where the order originated.
  • payments - Successful payments within the order
    <repeat value="#{order.payments}" var="payment">
      #{payment.___}
    </repeat>
  • purchaserAddress - #{order.purchaserAddress.___}
    • Purchaser physical address for the order
  • purchaserContact - #{order.purchaserContact.___}
    • Purchaser contact information for the order.
  • referrer - #{order.referrer}
    • Referrer that originated the order.
  • shippingTotal - #{order.shippingTotal}
    • Total of shipping applied
  • shippingTotalUSD - #{order.shippingTotalUSD}
    • USD total of shipping applied
  • siteDisplay - #{order.siteDisplay}
    • Displayable name of the site that the order originated from. Defaults to siteName.
  • siteMainUrl - #{order.siteMainUrl}
  • siteName - #{order.siteName}
  • siteSupportEmail - #{order.siteSupportEmail}
  • sourceCampaign - #{order.sourceCampaign}
  • sourceKey - #{order.sourceKey}
  • sourceName - #{order.sourceName}
  • status - #{order.status}
  • statusChange - #{order.statusChange}
    • Date / time that the status last changed. If the status is completed, then this is the date / time of completion.
  • subTotal - #{order.subTotal}
  • subTotalUSD - #{order.subTotalUSD}
  • surveyFieldValues - #{order.surveyFieldValues.___}
    • Survey field values, mapped by the name / key given to the survey field.
  • surveyFields - survey fields associated with the order
    <repeat value="#{order.surveyFields}" var="surveyField">
    #{surveyField.___}
    </repeat>
  • tagNameString - #{order.tagNameString}
    • String version of tag names. Example: tag_name_1, tag_name_2, etc.
  • tagString - #{order.tagString}
    • String version of tag names and tag values. Example: tag_name_1=5, tag_name_2=3, etc.
  • tags - #{order.tags.___}
    • Mapping of tag names to tag values.
  • tax - #{order.tax}
    • US sales tax, EU VAT tax, or Japanese Consumption Tax
  • taxUSD - #{order.taxUSD}
    • US sales tax, EU VAT tax, or Japanese Consumption Tax, USD
  • total - #{order.total}
  • totalUSD - #{order.totalUSD}
  • type - #{order.type}
  • url - #{order.url.___}
  • visibleItems - all order items visible to the consumer
  • <repeat value="#{order.visibleItems}" var="orderItem">
    #{orderItem.___}
    </repeat>

Subscription Variables

  • accountUrl - #{subscription.accountUrl}
  • attributes - #{subscription.attributes}
  • beginDate - #{subscription.beginDate}
    • First full day the subscription is considered active.
  • coupon - #{subscription.coupon}
    • Coupon code currently assigned to the subscription.
  • customer - #{subscription.customer.___}
    • Customer contact information for the subscription.
  • display - #{subscription.display}
    • Customer visible display of the subscription product, suitable for use in customer notifications / emails.
  • endDate - #{subscription.endDate}
    • End date of subscription. Last full day the subscription is considered active. The next day it will be canceled. A subscription will have an end date if it for a fixed number of periods, or if it has been set to cancel.
  • hasPaymentMethod - #{subscription.hasPaymentMethod}
    • false if the subscription doesn't have a payment method. Thus, isn't able to charge the bill.
  • hasSource - #{subscription.hasSource}
    • true if source information is available.
  • isTest - #{subscription.isTest}
    • true if the subscription is a test.
  • nextDunningStep - #{subscription.nextDunningStep}
    • The next dunning step or null if this subscription isn't in dunning.
  • nextDunningStepDate - #{subscription.nextDunningStepDate}
    • Date when the next payment attempt starts or null if this subscription isn't in dunning.
  • nextPeriodDate - #{subscription.nextPeriodDate}
    • Date when the next billing period starts or null if it's a 'On Demand' subscription.
  • notify - #{subscription.notify.___}
    • Contact information for the party receiving emails about the subscription.
  • paymentExpiresBeforeRenewalDate - #{subscription.paymentExpiresBeforeRenewalDate}
    • true if the payment method expiration date is on or before the next period date.
  • paymentMethodExpirationDate - #{subscription.paymentMethodExpirationDate}
    • Date when the payment method for the subscription expires.
  • productDisplay - #{subscription.productDisplay}
    • Display name of the product associated with the subscriptions, if different than the name. Use this variable for internal notifications.
  • productName - #{subscription.productName} 
  • productPath - #{subscription.productPath}; 
  • quantity - #{subscription.quantity}
  • reference - #{subscription.reference}
    • Unique API reference key.
  • referrer - #{subscription.referrer}
    • Custom referrer / identifier associated with the subscription.
  • siteName - #{subscription.siteName}
  • sourceCampaign - #{subscription.sourceCampaign}
  • sourceKey - #{subscription.sourceKey}
  • sourceName - #{subscription.sourceName}
  • status - #{subscription.status}
  • statusReason - #{subscription.statusReason}
    • Current reason for the status of the subscription, if any. 
  • successfulPeriodCount - #{subscription.successfulPeriodCount}
  • tagNameString - #{subscription.tagNameString}
    • String version of tag names. Example: tag_name_1, tag_name_2, etc.
  • tagString - #{subscription.tagString}; 
    • String version of tag names and tag values. Example: tag_name_1=5, tag_name_2=3, etc.
  • tags - #{subscription.tags.___}
    • Mapping of tag names to tag values.
  • terms - #{subscription.terms}
    • Human-readable terms of this subscription (e.g. $10 Monthly).
  • totalPrice - #{subscription.totalPrice}
    • The total recurring price (unit price times quantity).
  • url - # {subscription.url.___}

Return Variables

  • address - #{return.address.___}
  • allItems -
    <repeat value="#{return.allItems}" var="returnItem">
      #{returnItem.___}
    </repeat>
  • allProductNames
    <<repeat value="#{return.allProductNames}" var="value">
      #{value}
    </repeat>
  • baseItems
    <repeat value="#{return.baseItems}" var="returnItem">
      #{returnItem.___}
    </repeat>
  • baseProductNames - All base item product names.
  • <repeat value="#{return.baseProductNames}" var="value">
    #{value}
    </repeat>
  • created - #{return.created}
    • Date / time initially created.
  • currency - #{return.currency}
    • ISO 3 letter currency code of all monetary values within the order.
  • customer - #{return.customer.___}
    • Customer contact information for the order.
  • discountTotal - #{return.discountTotal}
  • discountTotalUSD - #{return.discountTotalUSD}
    • USD total of discounts applied, if any
  • hasReview - #{return.hasReview}
  • hasTax - #{return.hasTax}
    • true if tax was charged on the order.
  • hasUSTax - #{return.hasUSTax}
    • true if the tax represents U.S. sales tax.
  • hasVAT - #{return.hasVAT}
    • true if the tax represents VAT tax.
  • id - #{return.id}
  • isProcessing - #{return.isProcessing}
    • true if the order is processing -- the order is accepted, but not yet completed.
  • isTest - #{return.isTest}
    • true if the order is a test.
  • notify - #{return.notify.___}
    • Contact information for the party receiving emails about the order.
  • original - #{return.original.___}
  • purchaserAddress - #{return.purchaserAddress.___}
  • purchaserContact - #{return.purchaserContact.___}
    • Purchaser contact information for the order.
  • reasonText - #{return.reasonText}
  • review - #{return.review.___}
  • shippingTotal - #{return.shippingTotal}
    • Total of shipping applied
  • shippingTotalUSD - #{return.shippingTotalUSD}
    • USD total of shipping applied
  • siteDisplay - #{return.siteDisplay}
    • Displayable name of the site that the order originated from. Defaults to siteName.
  • siteMainUrl - #{return.siteMainUrl}
  • siteName - #{return.siteName}
  • siteSupportEmail - #{return.siteSupportEmail}
  • status - #{return.status}
  • statusChange - #{return.statusChange}
    • Date / time that the status last changed. If the status is completed, then this is the date / time of completion.
  • subTotal - #{return.subTotal}
  • subTotalUSD - #{return.subTotalUSD}
    • USD sub-total (excludes tax).
  • tax - #{return.tax}
    • US sales tax, EU VAT tax, or Japanese Consumption Tax
  • taxUSD - #{return.taxUSD}
    • US sales tax, EU VAT tax, or Japanese Consumption Tax, USD
  • total - #{return.total}
  • totalUSD - #{return.totalUSD}
  • type - #{return.type}