Endpoint

Get Accounts

Name

get_accounts

Description

Related Tables

Accounts

Parameters

Parameter

Label

Required

Options

Description

PageSize

Account email

CustomKey

Account custom key

GlobalKey

Account global key

OrderID

Account orderID

OrderReference

Account orderReference

SubscriptionId

Account subscriptionId

Products

filters results to include only transactions involving the specified product ID(s) / product path(s)

Refunds

Show Returned Only

Option	Value
true	true
false	false

filters results to include orders with or without returns; response includes returns array with return IDs where applicable

SubscriptionStatus

Subscription Status

Option	Value
active	active
ended	ended
canceled	canceled
started	started

'active', 'ended', 'canceled', 'started' will return accounts with subscriptions in the corresponding state

Output Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw
Id	`DT_WSTR`	`nvarchar(50)`	50	`False`
ContactFirst	`DT_WSTR`	`nvarchar(255)`	255	`False`
ContactLast	`DT_WSTR`	`nvarchar(255)`	255	`False`
ContactEmail	`DT_WSTR`	`nvarchar(255)`	255	`False`
ContactCompany	`DT_WSTR`	`nvarchar(255)`	255	`False`
ContactPhone	`DT_WSTR`	`nvarchar(255)`	255	`False`
ContactSubscribed	`DT_BOOL`	`bit`		`False`
AddressLine1	`DT_WSTR`	`nvarchar(255)`	255	`False`
AddressLine2	`DT_WSTR`	`nvarchar(255)`	255	`False`
City	`DT_WSTR`	`nvarchar(255)`	255	`False`
Region	`DT_WSTR`	`nvarchar(255)`	255	`False`
RegionCustom	`DT_WSTR`	`nvarchar(255)`	255	`False`
PostalCode	`DT_WSTR`	`nvarchar(255)`	255	`False`
AddressCompany	`DT_WSTR`	`nvarchar(255)`	255	`False`
Language	`DT_WSTR`	`nvarchar(255)`	255	`False`
Country	`DT_WSTR`	`nvarchar(255)`	255	`False`
LookupGlobal	`DT_WSTR`	`nvarchar(255)`	255	`False`
Url	`DT_WSTR`	`nvarchar(255)`	255	`False`
PaymentMethods	`DT_I8`	`bigint`		`False`
PaymentActive	`DT_I8`	`bigint`		`False`
Orders	`DT_NTEXT`	`nvarchar(MAX)`		`False`
Subscriptions	`DT_NTEXT`	`nvarchar(MAX)`		`False`
Charges	`DT_NTEXT`	`nvarchar(MAX)`		`False`
Subscribed	`DT_BOOL`	`bit`		`False`
TaxExemptionData	`DT_WSTR`	`nvarchar(4000)`	4000	`False`

If the column you are looking for is missing, consider customizing FastSpring Connector.

Input Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw	Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.

Examples

SSIS

Use FastSpring Connector in API Source component to read data or in API Destination component to read/write data:

Read from Accounts table using API Destination

This Endpoint belongs to Accounts table, therefore you cannot work with it directly. Use this table and table-operation pair instead:

FastSpring

Accounts

Select

SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Get accounts

SELECT * FROM get_accounts

Get all accounts

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_accounts endpoint belongs to Accounts table(s), and can therefore be used via those table(s).

SQL Server

Use these SQL queries in SQL Server after you create a data source in Data Gateway:

Get accounts

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM get_accounts';

EXEC (@MyQuery) AT [LS_TO_FASTSPRING_IN_GATEWAY];

Get all accounts

Get all accounts for your store

DECLARE @MyQuery NVARCHAR(MAX) = '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''
)
*/';

EXEC (@MyQuery) AT [LS_TO_FASTSPRING_IN_GATEWAY];

get_accounts endpoint belongs to Accounts table(s), and can therefore be used via those table(s).