SQL Server FastSpring Connector

In this article you will learn how to integrate FastSpring data to SQL Server without coding in just a few clicks (live / bi-directional connection to FastSpring). .

Using FastSpring Connector you will be able to connect, read, and write data from within SQL Server. Follow the steps below to see how we would accomplish that.

Download  Help File  Buy 

Video Tutorial - Integrate FastSpring data in SQL Server

This video covers following and more so watch carefully. After watching this video follow the steps described in this article.

  • How to download / install required driver for FastSpring integration in SQL Server
  • How to configure connection for FastSpring
  • Features about API Driver (Authentication / Query Language / Examples / Driver UI)
  • Using FastSpring Connection in SQL Server

Create Data Source in ZappySys Data Gateway based on ZappySys API Driver

  1. Download and install ZappySys ODBC PowerPack.

  2. Search for gateway in start menu and Open ZappySys Data Gateway:
    Open ZappySys Data Gateway

  3. Go to Users Tab to add our first Gateway user. Click Add; we will give it a name tdsuser and enter password you like to give. Check Admin option and click OK to save. We will use these details later when we create linked server:
    ZappySys Data Gateway - Add User

  4. Now we are ready to add a data source. Click Add, give data source a name (Copy this name somewhere, we will need it later) and then select Native - ZappySys API Driver. Finally, click OK. And it will create the Data Set for it and open the ZS driver UI.

    FastSpringDSN

    ZappySys Data Gateway - Add Data Source

  5. When the Configuration window appears give your data source a name if you haven't done that already, then select "FastSpring" from the list of Popular Connectors. If "FastSpring" is not present in the list, then click "Search Online" and download it. Then set the path to the location where you downloaded it. Finally, click Continue >> to proceed with configuring the DSN:

    FastSpringDSN
    FastSpring
    ODBC DSN Template Selection

  6. Now it's time to configure the Connection Manager. Select Authentication Type, e.g. Token Authentication. Then select API Base URL (in most cases, the default one is the right one). More info is available in the Authentication section.

    Steps to get FastSpring Credentials : Http [Http]
    Here is how to obtain API Credentials. You might be able to use your Account Login UserId / Password but we do not reccomend using it. Instead of that use API credentials generated using the following way.
    1. In the FastSpring App, navigate to Developer Tools > APIs > API Credentials.
    2. Click Create. FastSpring will automatically generate your username and password. Use this on the API connection UI
    3. Securely store the credentials for future reference.
    4. If you reset your credentials, update each stored procedure that relies on API access to prevent failed requests.

    Fill in all required parameters and set optional parameters if needed:

    FastSpringDSN
    FastSpring
    Http [Http]
    https://api.fastspring.com
    Required Parameters
    Optional Parameters
    UserName Fill in the parameter...
    Password Fill in the parameter...
    RetryMode Fill in the parameter...
    RetryStatusCodeList Fill in the parameter...
    RetryCountMax Fill in the parameter...
    RetryMultiplyWaitTime Fill in the parameter...
    Your Webstore URL Fill in the parameter...
    ODBC DSN HTTP Connection Configuration

  7. Once the data source has been configured, you can preview data. Select the Preview tab and use settings similar to the following to preview data:
    ODBC ZappySys Data Source Preview

  8. Click OK to finish creating the data source.

Read data in SQL Server from the ZappySys Data Gateway

  1. To read the data in SQL Server the first thing you have to do is create a Linked Server. Go to SQL Server Management Studio and configure it in a similar way:
    SSMS SQL Server Configure Linked Server

  2. Then click on Security option and configure username we created in ZappySys Data Gateway in one of the previous steps:
    SSMS SQL Server Configure Linked Server User Name

  3. Optional: Under the Server Options, Enable RPC and RPC Out and Disable Promotion of Distributed Transactions(MSDTC).

    RPC and MSDTC Settings

    You need to enable RPC Out if you plan to use EXEC(...) AT [MY_LINKED_SERVER_NAME] rather than OPENQUERY.
    If don't enabled it, you will encounter the Server 'MY_LINKED_SERVER_NAME' is not configured for RPC error.

    Query Example:

    EXEC('Select * from Products') AT [MY_LINKED_SERVER_NAME]


    If you plan to use 'INSERT INTO...EXEC(....) AT [MY_LINKED_SERVER_NAME]' in that case you need to Disable Promotion of Distributed Transactions(MSDTC).
    If don't disabled it, you will encounter the The operation could not be performed because OLE DB provider "SQLNCLI11" for linked server "MY_LINKED_SERVER_NAME" was unable to begin a distributed transaction. error.

    Query Example:

    Insert Into dbo.Products
     EXEC('Select * from Products') AT [MY_LINKED_SERVER_NAME]
    


  4. Finally, open a new query and execute a query we saved in one of the previous steps:

    SELECT * FROM OPENQUERY([MY_LINKED_SERVER_NAME], 'SELECT * FROM Products');

    SSMS SQL Server Query Data Results

Create Linked Server using Code

In previous section you saw how to create a Linked Server from UI. You can do similar action by code too (see below). Run below script after changing necessary parameters. Assuming your Data Source name on ZappySys Data Gateway UI is 'FastSpringDSN'

    USE [master]
    GO
    --///////////////////////////////////////////////////////////////////////////////////////
    --Run below code in SSMS to create Linked Server and use ZappySys Drivers in SQL Server
    --///////////////////////////////////////////////////////////////////////////////////////

    //Replace YOUR_GATEWAY_USER, YOUR_GATEWAY_PASSWORD
    //Replace localhost with IP/Machine name if ZappySys Gateway Running on different machine other than SQL Server
    //Replace Port 5000 if you configured gateway on a different port


    --1. Configure your gateway service as per this article https://zappysys.com/links?id=10036
    
    --2. Make sure you have SQL Server Installed. You can download FREE SQL Server Express Edition from here if you dont want to buy Paid version https://www.microsoft.com/en-us/sql-server/sql-server-editions-express

    --Uncomment below if you like to drop linked server if it already exists
    --EXEC master.dbo.sp_dropserver @server=N'LS_FastSpringDSN', @droplogins='droplogins'

    --3. Create new linked server
    
    EXEC master.dbo.sp_addlinkedserver
      @server = N'LS_FastSpringDSN'  --Linked server name (this will be used in OPENQUERY sql
    , @srvproduct=N''
    , @provider=N'SQLNCLI11'
    , @datasrc=N'localhost,5000' --//Machine / Port where Gateway service is running
    , @provstr=N'Network Library=DBMSSOCN;'
    , @catalog=N'FastSpringDSN' --Data source name you gave on Gateway service settings

    --4. Attach gateway login with linked server

    EXEC master.dbo.sp_addlinkedsrvlogin
      @rmtsrvname=N'LS_FastSpringDSN'  --linked server name
    , @useself=N'False'
    , @locallogin=NULL
    , @rmtuser=N'YOUR_GATEWAY_USER' --enter your Gateway user name
    , @rmtpassword='YOUR_GATEWAY_PASSWORD'  --enter your Gateway user's password
    GO

    --5. Enable RPC OUT (This is Optional - Only needed if you plan to use EXEC(...) AT YourLinkedServerName rather than OPENQUERY
    EXEC sp_serveroption 'LS_FastSpringDSN', 'rpc', true;
    EXEC sp_serveroption 'LS_FastSpringDSN', 'rpc out', true;

    --Disable MSDTC - Below needed to support INSERT INTO from EXEC AT statement
    EXEC sp_serveroption 'LS_FastSpringDSN', 'remote proc transaction promotion', false;
    
    --Increase query timeout if query is going to take longer than 10 mins (Default timeout is 600 seconds)
    --EXEC sp_serveroption 'LS_FastSpringDSN', 'query timeout', 1200;
    GO

Firewall settings

So far we have assumed that Gateway is running on the same machine as SQL Server. However there will be a case when ZappySys ODBC PowerPack is installed on a different machine than SQL Server. In such case you may have to perform additional Firewall configurations. On most computers firewall settings wont allow outside traffic to ZappySys Data Gateway. In such case perform following steps to allow other machines to connect to Gateway.

Method-1 (Preferred)

If you are using newer version of ZappySys Data Gateway then adding firewall rule is just a single click.

  1. Search for gateway in start menu and open ZappySys Data Gateway.
  2. Go to Firewall Tab and click Add Firewall Rule button like below. This will create Firewall rule to all Inbound Traffic on Port 5000 (Unless you changed it). Allow Inbound Traffic - Add Firewall Rule for ZappySys Data Gateway

Method-2 Here is another way to add / edit Inbound Traffic rule in windows firewall. Use below method if you choose to customize your rule (for advanced users).
  1. Search for Windows Firewall Advanced Security in start menu.
  2. Under Inbound Rules > Right click and click [New Rule] >> Click Next
  3. Select Port on Rule Type >> Click Next
  4. Click on TCP and enter port number under specified local port as 5000 (use different one if you changed Default port) >> Click Next
  5. Select Profile (i.e. Private, Public) >> Click Next
  6. Enter Rule name [i.e. ZappySys Data Gateway – Allow Inbound ] >> Click Next
  7. Click OK to save the rule
SQL Server Firewall Allow Inbound Data Gateway

OPENQUERY vs EXEC (handling larger SQL text)

So far we have seen examples of using OPENQUERY. It allows us to send pass-through query at remote server. The biggest limitation of OPENQUERY is it doesn't allow you to use variables inside SQL so often we have to use unpleasant looking dynamic SQL (Lots of tick, tick …. and escape hell). Well there is good news. With SQL 2005 and later you can use EXEC(your_sql) AT your_linked_server syntax . Disadvantage of EXEC AT is you cannot do SELECT INTO like OPENQUERY. Also you cannot perform JOIN like below in EXEC AT


    SELECT a.* FROM OPENQUERY([ls_FastSpringDSN],'select * from Customers') a
    JOIN OPENQUERY([ls_FastSpringDSN],'select * from Orders') b ON a.CustomerId=b.CustomerId;

However you can always do INSERT INTO SomeTable EXEC(…) AT your_linked_server. So table must exists when you do that way. Here is how to use it. To use EXEC(..) AT {linked-server} you must turn on RPC OUT option. Notice how we used variable in SQL to make it dynamic. This is much cleaner than previous approach we saw.

    USE [master]
    GO
    --Replace YOUR_GATEWAY_USER, YOUR_GATEWAY_PASSWORD
    --Replace localhost with IP/Machine name if ZappySys Gateway Running on different machine other than SQL Server

    --Create new linked server
    EXEC master.dbo.sp_addlinkedserver
      @server = N'LS_FastSpringDSN'  --Linked server name (this will be used in OPENQUERY sql)
    , @srvproduct=N''
    , @provider=N'SQLNCLI11'
    , @datasrc=N'localhost,5000' --//Machine / Port where Gateway service is running
    , @provstr=N'Network Library=DBMSSOCN;'
    , @catalog=N'FastSpringDSN' --Data source name you gave on Gateway service settings

    --Attach gateway login with linked server
    EXEC master.dbo.sp_addlinkedsrvlogin
      @rmtsrvname=N'LS_FastSpringDSN'  --linked server name
    , @useself=N'False'
    , @locallogin=NULL
    , @rmtuser=N'YOUR_GATEWAY_USER' --enter your Gateway user name
    , @rmtpassword='YOUR_GATEWAY_PASSWORD'  --enter your Gateway user's password
    GO

    --5. Enable RPC OUT (This is Optional - Only needed if you plan to use EXEC(...) AT YourLinkedServerName rather than OPENQUERY
    EXEC sp_serveroption 'LS_FastSpringDSN', 'rpc', true;
    EXEC sp_serveroption 'LS_FastSpringDSN', 'rpc out', true;
    --Disable MSDTC - Below needed to support INSERT INTO from EXEC AT statement
    EXEC sp_serveroption 'LS_FastSpringDSN', 'remote proc transaction promotion', false;
    --Increase query timeout if query is going to take longer than 10 mins (Default timeout is 600 seconds)
    --EXEC sp_serveroption 'LS_FastSpringDSN', 'query timeout', 1200;
    GO

Here is the difference between OPENQUERY vs EXEC approaches: OPENQUERY vs EXEC

Fetching Tables / Columns using metadata stored procs

ZappySys Data Gateway emulates certains system procs you might find in real SQL Server. You can call using below syntax using 4-Parts syntax
exec [linked-server-name].[gateway-datasource-name].[DATA].sp_tables
exec [linked-server-name].[gateway-datasource-name].[DATA].sp_columns_90 N'your-table-name'
Example:

    //List all tables
    exec [ls_FastSpringDSN].[FastSpringDSN].[DATA].sp_tables

    //List all columns and its type for specified table
    exec [ls_FastSpringDSN].[FastSpringDSN].[DATA].sp_columns_90 N'Account'

Known Issues

Let's explore some common problems that can occur when using OPENQUERY or Data Gateway connectivity.


Error: The data is invalid

There will be a time when, you may encounter unexpected errors like the ones listed below. These can include:

OLE DB provider "SQLNCLI11" for linked server "Zs_Csv" returned message "Deferred prepare could not be completed.".
OLE DB provider "SQLNCLI11" for linked server "Zs_Csv" returned message "Communication link failure".
Msg 13, Level 16, State 1, Line 0

Session Provider: The data is invalid.
Possible Cause:

There are few reasons for such error but below are two main reasons

  • If the query length exceeds 2000 characters, as shown below, you might encounter this error.

    SELECT * FROM OPENQUERY(LS, '--some really long text more than 2000 chars--')
  • If a query contains multiple OPENQUERY statements for JOINs or UNIONs, as shown below, it might fail due to a MARS compatibility issue where the gateway doesn't support parallel queries on a single connection.

    SELECT a.id, b.name from OPENQUERY(LS, 'select * from tbl1') a join OPENQUERY(LS, 'select * from tbl2') b on a.id=b.id
Possible Fix:

There are few ways to fix above error based on reason why you getting this error (i.e. Query Length issue OR JOIN/UNION in the same statement)

  • If your query has long SQL (more than 2000 chars ) then reduce SQL length using different techniques
    • e.g. use SELECT * FROM MyTable rather than SELECT col1,col2… FROM MyTable
    • Use Meta Option in WITH clause if you must use column name. (e.g. SELECT * FROM MyTable WITH(META=’c:\meta.txt’) this way you can define column in Meta file rather than SELECT query. Check this article
    • Consider using EXECT (….) AT [Linked_Server_name] option rather than OPENQUERY so you can use very long SQL (See next section on EXEC..AT usecase)
    • Consider using Virtual Table / Stored Proc to wrap long SQL so your call is very small (where usp_GetOrdersByYear is custom proc created on ZappySys Driver UI)
      SELECT * FROM OPENQUERY(LS, 'EXEC usp_GetOrdersByYear 2021')
  • If your query uses JOIN  / UNION with multiple OPENQUERY in same SQL then use multiple Linked servers (one for each OPENQUERY clause) as below.
    select a.id, b.name from OPENQUERY(LS_1, 'select * from tbl1') a join OPENQUERY(LS_2, 'select * from tbl2') b on a.id=b.id

Error: Unable to begin a distributed transaction (When INSERT + EXEC used)

If you try to use the EXEC statement to insert data into a table, as shown below, you might encounter the following error unless the MSDTC option is turned off.

INSERT INTO MyTable EXEC('select * from tbl') AT MyLinkedServer
"Protocol error in TDS stream"
The operation could not be performed because OLE DB provider "SQLNCLI11" for linked server "ls_Json2" was unable to begin a distributed transaction.
--OR--
The operation could not be performed because OLE DB provider "MSOLEDBSQL" for linked server "ls_Json" was unable to begin a distributed transaction.

Solution:
Method-1: Go to linked server properties | Server Options | Enable Promotion of Distributed Transaction | Change to false (Default is true)
Now your try your INSERT with EXEC AT and it should work

Method-2: Run the below command if you dont want to use UI

EXEC master.dbo.sp_serveroption @server=N'My_Linked_Server', @optname=N'remote proc transaction promotion', @optvalue=N'false'

Error: Cannot use OPENQUERY with JOIN / UNION

When you perform a JOIN or UNION ALL on the same Linked Server, it may fail to process sometimes because the Data Gateway doesn't support parallel query requests on the same connection. A workaround for that would be to create multiple linked servers for the same data source. Refer to the section above for the same workaround.


Error: Truncation errors due to data length mismatch

Many times, you may encounter truncation errors if a table column's length is less than the actual column size from the query column. To solve this issue, use the new version of Data Gateway and check the 'Use nvarchar(max) for string options' option found on the General Tab.


Performance Tips

Now, let's look at a few performance tips in this section.


Use INSERT INTO rather than SELECT INTO to avoid extra META request

We discussed some Pros and Cons of OPENQUERY vs EXEC (…) AT in previous section. One obvious advantage of EXEC (….) AT is it reduces number of requests to driver (It sends pass through query). With EXEC you cannot load data dynamically like SELECT INTO tmp FROM OPENQUERY. Table must exist before hand if you use EXEC.


INSERT INTO tmp_API_Report_Load(col1,col2)
EXEC('select col1,col2 from some_api_table') AT [API-LINKED-SERVER]
--OR--
INSERT INTO tmp_API_Report_Load(col1,col2)
select col1,col2 from OPENQUERY([API-LINKED-SERVER], 'select col1,col2 from some_api_table')

The advantage of this method is that your query speed will increase because the system only calls the API once when you use EXEC AT. In contrast, with OPENROWSET, the query needs to be called twice: once to obtain metadata and once to retrieve the data.


Use Cached Metadata if possible

By default, most SQL queries sent to the Data Gateway need to invoke two phases: first, to get metadata, and second, to fetch data. However, you can bypass the metadata API call by supplying static metadata. Use the META property in the WITH clause, as explained in this article, to speed up your SQL queries.

Create Custom Store Procedure in ZappySys Driver

You can create procedures to encapsulate custom logic and then only pass handful parameters rather than long SQL to execute your API call.

Steps to create Custom Store Procedure in ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here

  1. Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
    ZappySys Driver - Add Store Procedure

  2. Enter the desired Procedure name and click on OK:
    ZappySys Driver - Add Store Procedure Name

  3. Select the created Store Procedure and write the your desired store procedure and Save it and it will create the custom store procedure in the ZappySys Driver:
    Here is an example stored procedure for ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here

    CREATE PROCEDURE [usp_get_orders]
        @fromdate = '<<yyyy-MM-dd,FUN_TODAY>>'
     AS
        SELECT * FROM Orders where OrderDate >= '<@fromdate>';
    

    ZappySys Driver - Create Custom Store Procedure

  4. That's it now go to Preview Tab and Execute your Store Procedure using Exec Command. In this example it will extract the orders from the date 1996-01-01:

    Exec usp_get_orders '1996-01-01';

    ZappySys Driver - Execute Custom Store Procedure

  5. Let's generate the SQL Server Query Code to make the API call using store procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
    As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.

    SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC usp_get_orders @fromdate=''1996-07-30''')

    ZappySys Driver - Generate SQL Server Query

  6. Now go to SQL served and execute that query and it will make the API call using store procedure and provide you the response.
    ZappySys Driver - Generate SQL Server Query

Create Custom Virtual Table in ZappySys Driver

ZappySys API Drivers support flexible Query language so you can override Default Properties you configured on Data Source such as URL, Body. This way you don't have to create multiple Data Sources if you like to read data from multiple EndPoints. However not every application support supplying custom SQL to driver so you can only select Table from list returned from driver.

If you're dealing with Microsoft Access and need to import data from an SQL query, it's important to note that Access doesn't allow direct import of SQL queries. Instead, you can create custom objects (Virtual Tables) to handle the import process.

Many applications like MS Access, Informatica Designer wont give you option to specify custom SQL when you import Objects. In such case Virtual Table is very useful. You can create many Virtual Tables on the same Data Source (e.g. If you have 50 URLs with slight variations you can create virtual tables with just URL as Parameter setting.

  1. Go to Custom Objects Tab and Click on Add button and Select Add Table:
    ZappySys Driver - Add Table

  2. Enter the desired Table name and click on OK:
    ZappySys Driver - Add Table Name

  3. And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.

  4. Select the created table, Select Text Type AS SQL and write the your desired SQL Query and Save it and it will create the custom table in the ZappySys Driver:
    Here is an example SQL query for ZappySys Driver. You can insert Placeholders also. Read more about placeholders here

    SELECT
      "ShipCountry",
      "OrderID",
      "CustomerID",
      "EmployeeID",
      "OrderDate",
      "RequiredDate",
      "ShippedDate",
      "ShipVia",
      "Freight",
      "ShipName",
      "ShipAddress",
      "ShipCity",
      "ShipRegion",
      "ShipPostalCode"
    FROM "Orders"
    Where "ShipCountry"='USA'

    ZappySys Driver - Create Custom Table

  5. That's it now go to Preview Tab and Execute your custom virtual table query. In this example it will extract the orders for the USA Shipping Country only:

    SELECT * FROM "vt__usa_orders_only"

    ZappySys Driver - Execute Custom Virtual Table Query

  6. Let's generate the SQL Server Query Code to make the API call using store procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
    As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.

    SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC [usp_get_orders] ''1996-01-01''')

    ZappySys Driver - Generate SQL Server Query

  7. Now go to SQL served and execute that query and it will make the API call using store procedure and provide you the response.
    ZappySys Driver - Generate SQL Server Query

Conclusion

In this article we discussed how to connect to FastSpring in SQL Server and integrate data without any coding. Click here to Download FastSpring Connector for SQL Server and try yourself see how easy it is. If you still have any question(s) then ask here or simply click on live chat icon below and ask our expert (see bottom-right corner of this page).

Download FastSpring Connector for SQL Server Documentation 

Actions supported by FastSpring Connector

FastSpring Connector support following actions for REST API integration. If some actions are not listed below then you can easily edit Connector file and enhance out of the box functionality.
 Get Product IDs
   [Read more...]
 Get Products
   [Read more...]
 Get Products Publish Status
   [Read more...]
 Get Product
   [Read more...]
Parameter Description
Product Id
 Create Product
   [Read more...]
 Update Product
   [Read more...]
 Get Product Prices
   [Read more...]
Parameter Description
Country Code
Currency Code
 Get Order Items
   [Read more...]
 Get Order Items by OrderId
   [Read more...]
Parameter Description
Order Id
 Get Orders
   [Read more...]
 Get Order by Id
   [Read more...]
Parameter Description
Order Id
 Get Accounts
   [Read more...]
 Get Account Orders
   [Read more...]
 Get Account Charges
   [Read more...]
 Get Account Orders
   [Read more...]
Parameter Description
Account Id
 Get Account Charges by Id
   [Read more...]
Parameter Description
Account Id
 Get Account By Id
   [Read more...]
Parameter Description
Account Id
 Get Subscriptions Ids
   [Read more...]
 Get Subscriptions
   [Read more...]
 Get Subscription By Id
   [Read more...]
Parameter Description
Subscription Id
 Get Quote By Id
   [Read more...]
Parameter Description
Quote Id
 Get Quotes
   [Read more...]
 Get Subscription Report
   [Read more...]
Parameter Description
ReportColumns
Option Value
activations activations
arr arr
average_mrr average_mrr
buyer_email buyer_email
buyer_id buyer_id
cancellations cancellations
chargeback_true_false chargeback_true_false
company_id company_id
company_name company_name
country_iso country_iso
country_name country_name
coupon coupon
customer_churn customer_churn
discount discount
driving_offer_type driving_offer_type
driving_product_path driving_product_path
item_id item_id
lifetime_value lifetime_value
mrr mrr
mrr_decrease mrr_decrease
mrr_downgrade mrr_downgrade
mrr_growth_rate mrr_growth_rate
mrr_increase mrr_increase
mrr_paused mrr_paused
mrr_resumed mrr_resumed
mrr_upgrade mrr_upgrade
new_subscribers new_subscribers
occurred_date occurred_date
order_id order_id
product_display_name product_display_name
product_id product_id
product_name product_name
product_path product_path
purchase_type purchase_type
return_true_false return_true_false
revenue_churn revenue_churn
store_id store_id
store_name store_name
subscriber_loss subscriber_loss
subscribers subscribers
subscription_period subscription_period
subscription_period_end subscription_period_end
subscription_period_start subscription_period_start
subscription_start_date subscription_start_date
subscription_status subscription_status
subscription_true_false subscription_true_false
subscriptions subscriptions
sync_date sync_date
transaction_currency transaction_currency
transaction_date transaction_date
transaction_month transaction_month
transaction_type transaction_type
transaction_year transaction_year
GroupByColumns
Option Value
buyer_email buyer_email
buyer_id buyer_id
chargeback_true_false chargeback_true_false
company_id company_id
company_name company_name
country_iso country_iso
country_name country_name
coupon coupon
discount discount
driving_offer_type driving_offer_type
driving_product_path driving_product_path
item_id item_id
occurred_date occurred_date
order_id order_id
product_display_name product_display_name
product_id product_id
product_name product_name
product_path product_path
purchase_type purchase_type
return_true_false return_true_false
store_id store_id
store_name store_name
subscription_period subscription_period
subscription_period_end subscription_period_end
subscription_period_start subscription_period_start
subscription_start_date subscription_start_date
subscription_status subscription_status
subscription_true_false subscription_true_false
sync_date sync_date
transaction_currency transaction_currency
transaction_date transaction_date
transaction_month transaction_month
transaction_type transaction_type
transaction_year transaction_year
 Get Revenue Report
   [Read more...]
Parameter Description
ReportColumns
Option Value
Buyer_Email Buyer_Email
Buyer_ID Buyer_ID
Chargeback_True_False Chargeback_True_False
Company_ID Company_ID
Company_Name Company_Name
Country_ISO Country_ISO
Country_Name Country_Name
CouponDigital_Backup_Fulfillment_Fee CouponDigital_Backup_Fulfillment_Fee
Digital_Backup_Fulfillment_Fee_in_USD Digital_Backup_Fulfillment_Fee_in_USD
Digital_Fulfillment_Fee Digital_Fulfillment_Fee
Digital_Fulfillment_Fee_in_USD Digital_Fulfillment_Fee_in_USD
Discount Discount
Driving_Offer_TypeDriving_Product_Path Driving_Offer_TypeDriving_Product_Path
Fixed_FeeFixed_Fee_in_USDIncomeIncome_in_USDItem_ID Fixed_FeeFixed_Fee_in_USDIncomeIncome_in_USDItem_ID
Order_ID Order_ID
Physical_Backup_Fulfillment_Fee Physical_Backup_Fulfillment_Fee
Physical_Backup_Fulfillment_Fee_in_USD Physical_Backup_Fulfillment_Fee_in_USD
Product_Display_Name Product_Display_Name
Product_ID Product_ID
Product_Name Product_Name
Product_Path Product_Path
Purchase_Type Purchase_Type
Return_Fee Return_Fee
Return_Fee_in_USD Return_Fee_in_USD
Return_True_False Return_True_False
SegmentStore_Chargeback_Fee SegmentStore_Chargeback_Fee
Store_ID Store_ID
Store_Name Store_Name
Subscription_Period Subscription_Period
Subscription_Period_End Subscription_Period_End
Subscription_Period_Start Subscription_Period_Start
Subscription_Start_Date Subscription_Start_Date
Subscription_Status Subscription_Status
Subscription_True_False Subscription_True_False
Tax Tax
Tax_Fee Tax_Fee
Tax_Fee_in_USD Tax_Fee_in_USD
Tax_in_USD Tax_in_USD
Transaction_Amount Transaction_Amount
Transaction_Amount_in_USD Transaction_Amount_in_USD
Transaction_Currency Transaction_Currency
Transaction_Date Transaction_Date
Transaction_Fee Transaction_Fee
Transaction_Fee_in_USD Transaction_Fee_in_USD
Transaction_Item_Count Transaction_Item_Count
Transaction_Month Transaction_Month
Transaction_Rate Transaction_Rate
Transaction_Time_UTC Transaction_Time_UTC
Transaction_Type Transaction_Type
Transaction_Year Transaction_Year
Grand_Total_In_USD Grand_Total_In_USD
syncDatecountryISO syncDatecountryISO
Product_Count Product_Count
Product_Units Product_Units
GroupByColumns
Option Value
Buyer_Email Buyer_Email
Buyer_ID Buyer_ID
Chargeback_True_False Chargeback_True_False
Company_ID Company_ID
Company_Name Company_Name
Country_ISO Country_ISO
Country_Name Country_Name
Coupon Coupon
Discount Discount
Driving_Offer_Type Driving_Offer_Type
Driving_Product_Path Driving_Product_Path
Income Income
Item_ID Item_ID
Order_ID Order_ID
Product_Display_Name Product_Display_Name
Product_ID Product_ID
Product_Name Product_Name
Product_Path Product_Path
Purchase_Type Purchase_Type
Return_True_False Return_True_False
Segment Segment
Store_ID Store_ID
Store_Name Store_Name
Subscription_Period Subscription_Period
Subscription_Status Subscription_Status
Subscription_True_False Subscription_True_False
Transaction_Currency Transaction_Currency
Transaction_Date Transaction_Date
Transaction_Month Transaction_Month
Transaction_Type Transaction_Type
Transaction_Year Transaction_Year
countryISO countryISO
 Generic Request
This is generic endpoint. Use this endpoint when some actions are not implemented by connector. Just enter partial URL (Required), Body, Method, Header etc. Most parameters are optional except URL.    [Read more...]
Parameter Description
Url API URL goes here. You can enter full URL or Partial URL relative to Base URL. If it is full URL then domain name must be part of ServiceURL or part of TrustedDomains
Body Request Body content goes here
IsMultiPart Check this option if you want to upload file(s) (i.e. POST RAW file data) or send data using Multi-Part encoding method (i.e. Content-Type: multipart/form-data). Multi-Part request allows you to mix key/value and upload files in same request. On the other hand raw upload allows only single file upload (without any key/value) ==== Raw Upload (Content-Type: application/octet-stream) ===== To upload single file in raw mode check this option and specify full file path starting with @ sign in the Body (e.g. @c:\data\myfile.zip ) ==== Form-Data / Multipart Upload (Content-Type: multipart/form-data) ===== To treat your Request data as multi part fields you must specify key/value pairs separated by new lines into RequestData field (i.e. Body). Each key value pair is entered on new-line and key/value are separated using equal sign (=). Preceding and trailing spaces are ignored also blank lines are ignored. If field value has some any special character(s) then use escape sequence (e.g. For NewLine: \r\n, For Tab: \t, For at (@): \@). When value of any field starts with at sign (@) its automatically treated as File you want to upload. By default file content type is determined based on extension however you can supply content type manually for any field using this way [ YourFileFieldName.Content-Type=some-content-type ]. By default File Upload Field always includes Content-Type in the request (non file fields do not have content-type by default unless you supply manually). For some reason if you dont want to use Content-Type header in your request then supply blank Content-Type to exclude this header altogather [e.g. SomeFieldName.Content-Type= ]. In below example we have supplied Content-Type for file2 and SomeField1, all other fields are using default content-type. See below Example of uploading multiple files along with additional fields. If some API requires you to pass Content-Type: multipart/form-data rather than multipart/form-data then manually set Request Header => Content-Type: multipart/mixed (it must starts with multipart/ else will be ignored). file1=@c:\data\Myfile1.txt file2=@c:\data\Myfile2.json file2.Content-Type=application/json SomeField1=aaaaaaa SomeField1.Content-Type=text/plain SomeField2=12345 SomeFieldWithNewLineAndTab=This is line1\r\nThis is line2\r\nThis is \ttab \ttab \ttab SomeFieldStartingWithAtSign=\@MyTwitterHandle
Filter Enter filter to extract array from response. Example: $.rows[*] --OR-- $.customers[*].orders[*]. Check your response document and find out hierarchy you like to extract
Headers Headers for Request. To enter multiple headers use double pipe or new line after each {header-name}:{value} pair

FastSpring Connector Examples for SQL Server Connection

This page offers a collection of SQL examples designed for seamless integration with the ZappySys API ODBC Driver under ODBC Data Source (36/64) or ZappySys Data Gateway, enhancing your ability to connect and interact with Prebuilt Connectors effectively.

Read orders    [Read more...]

Read all orders

SELECT * FROM Orders

Read a single order by id    [Read more...]

Read a single order by id

SELECT * FROM Orders Where Id='zzzzzzzzzz'

Read orders with date range    [Read more...]

Read all orders within specific date range

SELECT * FROM Orders WITH(StartDate='2020-01-01', EndDate='2021-12-31' ) --use function like today, yesterday, yearstart, monthstart, yearstart-1y

Read orders placed in last 30 days    [Read more...]

Read all orders placed in last 30 days. This hows how to use function like today, yesterday, yearstart, monthstart, yearstart-1y etc for date parameters

SELECT * FROM Orders 
--WHERE Currency='USD' and TotalInPayoutCurrency>=1599
WITH(StartDate='today-30day', EndDate='today') --try today, yesterday, yearstart, yearend, monthstart, monthend, yearstart-1y so on

Read product ids    [Read more...]

Read all orders

SELECT * FROM get_product_ids

Read product details    [Read more...]

Read all products

SELECT * FROM Products

Read a single product by id    [Read more...]

Read a single product by id

SELECT * FROM Products Where Id='some-product-id'

Read product prices    [Read more...]

List product prices for specified currency or country. If you do not pass Country or Currency Parameter then all prices for all countries listed

SELECT 
 Product,
 Country,
 Currency,
 Price,
 PriceDisplay,
 
 Discount2DiscountPercent,
 Discount2DiscountValue,
 Discount2DiscountValueDisplay,
 Discount2UnitPrice,
 Discount2UnitPriceDisplay,
 
 Discount3DiscountPercent,
 Discount3DiscountValue,
 Discount3DiscountValueDisplay,
 Discount3UnitPrice,
 Discount3UnitPriceDisplay,
 
 Discount4DiscountPercent,
 Discount4DiscountValue,
 Discount4DiscountValueDisplay,
 Discount4UnitPrice,
 Discount4UnitPriceDisplay,
 
 Discount5DiscountPercent,
 Discount5DiscountValue,
 Discount5DiscountValueDisplay,
 Discount5UnitPrice,
 Discount5UnitPriceDisplay,
 
 DiscountReasonEn,
 DiscountPeriodCount,

 AvailableStart,
 AvailableEnd,
 SetupFeePrice,
 SetupFeePriceDisplay,
 SetupFeeReasonEn
 
FROM ProductPrices 
--WITH(Country='US') --//get prices for a specific country
--WITH(Currency='USD') --//get proces for a specific currency

Update Product    [Read more...]

Update product attributes by its ID

UPDATE Products
SET 
  Display='Product ABCD'
, Sku='PRD-ABCD-01'
, Summary='Product Abcd **STD**'
, Description='This product can be used to call **API** supports markdown syntax'
, Action='**Action** supports markdown'
, TaxCode='DC010500'
, Image='https://zappysys.com/api/images/ZappySys-icon.png'
, FulfillmentInstructions='Thank you for shopping. **Activate** license by using our License App'
, Format='digital'
, PriceUSD='101.5'
, PriceEUR='102.5'
, PriceGBP='103.5'
, PriceCAD='104.5'
, PriceNZD='105.5'
, PriceCHF='106.5'
, PriceSEK='107.5'
, PriceCZK='108.5'
, PriceDKK='109.5'
, PricePLN='101.5'
, PriceSGD='102.5'
, PriceJPY='103.5'
, PriceCNY='104.5'
, PriceHKD='105.5'
, PriceINR='106.5'
, PriceBRL='107.5'
, PriceAUD='108.5'

, Badge='Badge-1'
, Rank=1
, Trial=14 --how many trial days
, TrialPriceUSD=10.5 

--, Renew=1 --not allowed for update : Only for create (enable subscription)
, Interval='year' --allowed values: adhoc, day, week, year, only needed if you are creating a subscription
, IntervalLength=1
, IntervalCount=0

, QuantityBehavior='allow' --allowed values: allow, lock, hide
, QuantityDefault=1
, Attributes = '{"mykey-1" : "some-value-1", "mykey-2" : "some-value-2"}'
--, Fulfillments='[ { fullfillment }, { fullfillment } ... ]' --JSON fragment 	
Where Id='abcd'

Update multiple Products (read from CSV file)    [Read more...]

Update multiple products from CSV file or other external source (e.g. Microsoft SQL Server, MySQL, Postgresql, ODBC)

UPDATE Products
SOURCE('ODBC',

--File input example (use as to match Column name allowed in Products Table to write)
--'Driver={ZappySys CSV Driver};DataPath=c:\data\products.csv',
--'select P_ID as Id,P_TAXCODE as TaxCode From $'

--Direct input example
'Driver={ZappySys CSV Driver}',
'select ''abcd'' as Id, ''DC010500'' as TaxCode UNION
 select ''xyz'' as Id, ''DC010500'' as TaxCode UNION
 select ''zzz'' as Id, ''DC010500'' as TaxCode 
'
)

Create or Update Product (Upsert)    [Read more...]

Create or Update product (Upsert)

--Insert or Update
--UPSERT INTO Products 

--Insert or Update
UPSERT INTO Products
(     [Id]	, [Display]	, [Summary]
	, [Description]	, [Action]	, [Format]
	, [Sku]	, [TaxCode]	, [Image]
	, [Renew]	, [Interval]	, [IntervalLength]
	, [IntervalCount]	, [QuantityBehavior]	, [QuantityDefault]
	, [PriceUSD]	, [PriceEUR]	, [PriceGBP]
	, [PriceCAD]	, [PriceNZD]	, [PriceCHF]
	, [PriceSEK]	, [PriceCZK]	, [PriceDKK]
	, [PricePLN]	, [PriceSGD]	, [PriceJPY]
	, [PriceCNY]	, [PriceHKD]	, [PriceINR]	, [PriceBRL]	, [PriceAUD]
	, [Trial]	
	, [TrialPriceUSD]	, [TrialPriceEUR]	, [TrialPriceGBP]
	, [PaymentCollected]	, [PaidTrial]
	, [FulfillmentInstructions]
	, [DateLimitsEnabled]	, [CancellationInterval]	, [CancellationIntervalLength]	
	, [SetupFeeTitle]	
	, [SetupFeePriceUSD]	, [SetupFeePriceEUR]	, [SetupFeePriceGBP]	
	, [Badge]	, [Rank]	
	, [Attributes]		
	)
VALUES('test-std-id'
	, '3Year **standard** subscription edition'
	, 'summary **standard edition** _some italic_ ' -- markdown syntax allowed
	
	, 'long description **test STD** and many more lines' --markdown syntax allowed
	, 'action text with **markdown** '
	, 'digital' -- e.g. digital OR physical OR digital-and-physical
	
	, 'TEST-STD-001'
	, 'DC010500'
	, 'https://zappysys.com/api/images/ZappySys-icon.png'
	
	, true	, 'year'	, 1
	, 1 	, 'allow' -- e.g. allow Or lock Or hide
	, 3	--stop renewal after 3 periods
	, 10.12	, 11.12	, 12.12	
	, 13.12	, 14.12	, 15.12	
	, 16.12	, 17.12	, 18.12	
	, 19.12	, 20.12	, 21.12	
	, 22.12	, 23.12	, 24.12	, 25.12	, 26.12	
    , 14 --how many days trial allowed
    , 10.12	, 11.12	, 12.12	
    , 'true', true
	, 'Thank you for shopping, **here are** license instructions' --markdown supported
	, false, 'day', 5
	, 'Setup title'	
	--setup fees in common currencies
	, 10.50	, 11.50	, 12.50	
	, 'badge-1'	, 1
	, '{"mykey-1" : "some-value-1", "mykey-2" : "some-value-2"}' --JSON fragment 
	--, '[... fullfillments.. ]' --JSON fragment 	
)

List / Search Quotes    [Read more...]

List or Search quotes. This example lists Open and Completed Quotes

SELECT * FROM Quotes 
WITH(
	  Statuses='OPEN~COMPLETED',
	  --SearchFor='Test' --quote contains word "Test" in Name or blling information
	  -- query more status like below
	  --Statuses='OPEN~COMPLETED~CANCELED~EXPIRED',
	  
)

List Product Publish Status - Public=200, Private=404    [Read more...]

List product publish status (200=Published, 404=Private)

select * from get_products_visibility

List all orders for a specific subscription    [Read more...]

List all orders for a specific subscription

SELECT * FROM Orders 
WHERE SubscriptionId_1='iBPfMFS6TZSxrLzSOrq8PQ' 
	OR SubscriptionId_2='iBPfMFS6TZSxrLzSOrq8PQ'
	OR SubscriptionId_3='iBPfMFS6TZSxrLzSOrq8PQ' 
ORDER BY OrderDate

Generate Subscription Report by Date, Product, Group By    [Read more...]

Generate subscription report for selected group by columns, date range, products and more

SELECT *
FROM get_subscription_report
Order by transaction_date
WITH(
	  Country='AL~UA~US'
	, ProductPaths='odbc-pp-ent-sub~odbc-pp-pro-sub~odbc-pp-std~ssis-pp-pro-sub~ssis-pp-std-sub~ssis-pp-ent-sub'
	, StartDate='monthstart-1m' --or  2022-01-01
	, EndDateDate='monthend+2d' --or  2022-01-01
	, ReportColumns='transaction_date~transaction_month~transaction_year~activations~average_mrr~cancellations~mrr~new_subscribers~subscriptions'
	, GroupByColumns='transaction_date~transaction_month~transaction_year'
)

Generate Revenue Report by Date, Product, Group By    [Read more...]

Generate revenue report for selected group by columns, date range, products and more

SELECT *
FROM get_revenue_report
Order by transaction_date
WITH(
	  Country='AL~UA~US'
	, ProductPaths='odbc-pp-ent-sub~odbc-pp-pro-sub~odbc-pp-std~ssis-pp-pro-sub~ssis-pp-std-sub~ssis-pp-ent-sub'
	, StartDate='monthstart-1m' --or  2022-01-01
	, EndDateDate='monthend+2d' --or  2022-01-01
	, ReportColumns='Transaction_Year~Transaction_Month~Transaction_Date~Company_Name~Product_Path~Product_Units~Tax_in_USD~Transaction_Amount_in_USD~Grand_Total_In_USD'
	, GroupByColumns='transaction_date~transaction_month~transaction_year'
)

Get all accounts    [Read more...]

Get all accounts for your store

SELECT *
FROM Accounts	

SELECT "Id"
	, "ContactFirst"
	, "ContactLast"
	, "ContactEmail"
	, "ContactCompany"
	, "ContactPhone"
	, "ContactSubscribed"
	, "AddressLine1"
	, "AddressLine2"
	, "City"
	, "Region"
	, "RegionCustom"
	, "PostalCode"
	, "AddressCompany"
	, "Language"
	, "Country"
	, "LookupGlobal"
	, "Url"
	, "PaymentMethods"
	, "PaymentActive"
	, "Orders"
	, "Subscriptions"
	, "Charges"
	, "Subscribed"
	, "TaxExemptionData"
FROM Accounts

--Use WITH clause --OR-- Key column(s) in WHERE clause
--WHERE [Id] = 'abcd'

--search by one or more parameters below
/*
WITH(
	  Email='X'
	, CustomKey='X'
	, GlobalKey='X'
	, OrderID='X'
	, OrderReference='X'
	, SubscriptionId='X'
	, Products='PROD-1,PROD-2,PROD-3'
	, Refunds='true'
	, SubscriptionStatus='active'
)
*/

Get all accounts with specific product orders    [Read more...]

Use below query to search accounts who placed orders for specific products

SELECT * from Accounts WITH(Products='ssis-pp-pro,ssis-pp-pro-sub,ssis-pp-ent,ssis-pp-ent-sub')

Get account charges    [Read more...]

Use below query to search account charges

SELECT * from AccountCharges 

--search by one or more parameters below
/*
WITH(
	  Email='X'
	, CustomKey='X'
	, GlobalKey='X'
	, OrderID='X'
	, OrderReference='X'
	, SubscriptionId='X'
	, Products='PROD-1,PROD-2,PROD-3'
	, Refunds='true'
	, SubscriptionStatus='active'
)
*/

Get account orders by email id    [Read more...]

Use below query to search for accounts and orders with search criteria

SELECT * from AccountOrders
WITH(
	  Email='bob@abc.com'
)
	  
--search by one or more parameters below
/*
WITH(
	  Email='X'
	, CustomKey='X'
	, GlobalKey='X'
	, OrderID='X'
	, OrderReference='X'
	, SubscriptionId='X'
	, Products='PROD-1,PROD-2,PROD-3'
	, Refunds='true'
	, SubscriptionStatus='active'
)
*/

Get specific order by reference number (rather than Id)    [Read more...]

Search by Order by reference (fast way). If you have less rows then use Select * FROM Orders where Reference='BIX-123' it can be faster than below appproach

SELECT * from AccountOrders WHERE Reference='BIN240202-9666-28133' WITH(OrderReference='BIN240202-9666-28133')	
--or for handful rows use below way
--SELECT * from Orders WHERE Reference='BIN240202-9666-28133'

Other App Integration scenarios for FastSpring

Other Connectors for SQL Server


Download FastSpring Connector for SQL Server Documentation 

  • How to connect FastSpring in SQL Server?

  • How to get FastSpring data in SQL Server?

  • How to read FastSpring data in SQL Server?

  • How to load FastSpring data in SQL Server?

  • How to import FastSpring data in SQL Server?

  • How to pull FastSpring data in SQL Server?

  • How to push data to FastSpring in SQL Server?

  • How to write data to FastSpring in SQL Server?

  • How to POST data to FastSpring in SQL Server?

  • Call FastSpring API in SQL Server

  • Consume FastSpring API in SQL Server

  • FastSpring SQL Server Automate

  • FastSpring SQL Server Integration

  • Integration FastSpring in SQL Server

  • Consume real-time FastSpring data in SQL Server

  • Consume realtime FastSpring API data in SQL Server

  • FastSpring ODBC Driver | ODBC Driver for FastSpring | ODBC FastSpring Driver | SSIS FastSpring Source | SSIS FastSpring Destination

  • Connect FastSpring in SQL Server

  • Load FastSpring in SQL Server

  • Load FastSpring data in SQL Server

  • Read FastSpring data in SQL Server

  • FastSpring API Call in SQL Server