Reference

Endpoint Get Quotes

Name

get_quotes

Description

Related Tables

Quotes

Parameters

Parameter Required Options
Name: PageSize

Label: PageSize
Name: CreatedBegin

Label: Created Begin Date (yyyy-MM-dd)

filters results to include quotes created after the specified begin date (must be at least one day before the specified end date)
Option Value
2023-12-31 2023-12-31
today today
yesterday yesterday
yearstart-10y yearstart-10y
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
monthend+1d-1y monthend+1d-1y
Name: CreatedEnd

Label: Created End Date (yyyy-MM-dd)

filters results to include quotes created before the specified end date
Option Value
2023-12-31 2023-12-31
today today
yesterday yesterday
yearstart-10y yearstart-10y
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
monthend+1d-1y monthend+1d-1y
Name: CreatedEmail

Label: Created Email
Name: QuoteId

Label: QuoteId
Name: SearchFor

Label: SearchFor
Name: Statuses

Label: Statuses
Option Value
OPEN OPEN
COMPLETED COMPLETED
CANCELED CANCELED
EXPIRED EXPIRED
Name: expiresBegin

Label: Expires Begin Date (yyyy-MM-dd)

filters results to include quotes expiring after the specified begin date (must be at least one day before the specified end date)
Option Value
2023-12-31 2023-12-31
today today
yesterday yesterday
yearstart-10y yearstart-10y
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
monthend+1d-1y monthend+1d-1y
Name: expiresEnd

Label: Expires End Date (yyyy-MM-dd)

filters results to include quotes expiring before the specified end date
Option Value
2023-12-31 2023-12-31
today today
yesterday yesterday
yearstart-10y yearstart-10y
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
monthend+1d-1y monthend+1d-1y
Name: expiresBefore

Label: Expires Before Date (yyyy-MM-dd)

filters results to include quotes expiring before the specified end date
Option Value
2023-12-31 2023-12-31
today today
yesterday yesterday
yearstart-10y yearstart-10y
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
monthend+1d-1y monthend+1d-1y

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
Id DT_WSTR nvarchar(100) 100
Name DT_WSTR nvarchar(128) 128
Status DT_WSTR nvarchar(100) 100
OrderReference DT_WSTR nvarchar(100) 100
Created DT_DBTIMESTAMP datetime
Currency DT_WSTR nvarchar(12) 12
TotalInPayoutCurrency DT_R8 float
SubtotalInPayoutCurrency DT_R8 float
Item_1 DT_WSTR nvarchar(100) 100 First item from this quote
Item_2 DT_WSTR nvarchar(100) 100 Second item from this quote
Item_3 DT_WSTR nvarchar(100) 100 Third item from this quote
InvoiceId DT_WSTR nvarchar(100) 100
Coupon DT_WSTR nvarchar(100) 100
Subtotal DT_R8 float
SubtotalDisplay DT_WSTR nvarchar(100) 100
SubtotalInPayoutCurrencyDisplay DT_WSTR nvarchar(100) 100
Tags DT_WSTR nvarchar(4000) 4000
Tax DT_R8 float
TaxRate DT_R8 float
TaxType DT_WSTR nvarchar(100) 100
Total DT_R8 float
TotalDisplay DT_WSTR nvarchar(100) 100
TotalInPayoutCurrencyDisplay DT_WSTR nvarchar(100) 100
Updated DT_DBTIMESTAMP datetime
TaxId DT_WSTR nvarchar(100) 100
RecipientCompany DT_WSTR nvarchar(100) 100
RecipientEmail DT_WSTR nvarchar(255) 255
RecipientFirst DT_WSTR nvarchar(100) 100
RecipientLast DT_WSTR nvarchar(100) 100
RecipientPhone DT_WSTR nvarchar(100) 100
RecipientUserId DT_WSTR nvarchar(100) 100
RecipientAddressAddressLine1 DT_WSTR nvarchar(100) 100
RecipientAddressAddressLine2 DT_WSTR nvarchar(100) 100
RecipientAddressCity DT_WSTR nvarchar(100) 100
RecipientAddressCountry DT_WSTR nvarchar(100) 100
RecipientAddressPostalCode DT_WSTR nvarchar(100) 100
RecipientAddressRegion DT_WSTR nvarchar(100) 100
CreatedByCompany DT_WSTR nvarchar(100) 100
CreatedByEmail DT_WSTR nvarchar(100) 100
CreatedByFirst DT_WSTR nvarchar(100) 100
CreatedByLast DT_WSTR nvarchar(100) 100
CreatedByPhone DT_WSTR nvarchar(100) 100
CreatedByUserId DT_WSTR nvarchar(100) 100
Discount DT_R8 float
DiscountDisplay DT_WSTR nvarchar(100) 100
DiscountInPayoutCurrency DT_R8 float
DiscountInPayoutCurrencyDisplay DT_WSTR nvarchar(100) 100
Expires DT_DBTIMESTAMP datetime
ExpirationDateDays DT_I8 bigint
FulfillmentTerm DT_WSTR nvarchar(100) 100
BuyerGenerated DT_BOOL bit
CopyNotesToInvoice DT_BOOL bit
Items DT_NTEXT nvarchar(MAX)
Notes DT_WSTR nvarchar(4000) 4000
NetTermsDays DT_I8 bigint
QuoteUrl DT_WSTR nvarchar(448) 448
SiteId DT_WSTR nvarchar(100) 100
StatusHistory DT_WSTR nvarchar(4000) 4000
Source DT_WSTR nvarchar(100) 100
SourceIP DT_WSTR nvarchar(100) 100
IsGrossTax DT_BOOL bit
If the column you are looking for is missing, consider customizing FastSpring Connector.

Input Columns

Label Data Type (SSIS) Data Type (SQL) Length 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 or in API Destination SSIS Data Flow components to read or write data.

API Source

This Endpoint belongs to the Quotes table, therefore it is better to use it, instead of accessing the endpoint directly:

API Source - FastSpring
Read / write FastSpring data related to Orders, Subscriptions, Quotes, Products, Accounts and more without coding.
FastSpring
Quotes
There are no parameters to configure.
SSIS API Source - Read from table or endpoint

API Destination

This Endpoint belongs to the Quotes table, therefore it is better to use it, instead of accessing the endpoint directly. Use this table and table-operation pair to get quotes:

API Destination - FastSpring
Read / write FastSpring data related to Orders, Subscriptions, Quotes, Products, Accounts and more without coding.
FastSpring
Quotes
Select
There are no parameters to configure.
SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

List / Search Quotes

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',
	  
)

get_quotes endpoint belongs to Quotes 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:

List / Search Quotes

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

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

EXEC (@MyQuery) AT [LS_TO_FASTSPRING_IN_GATEWAY];

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