FastSpring Connector
Documentation
Version: 1
Documentation
Home » API Integration Hub » FastSpring Connector » EndPoints » Get Orders

EndPoint Get Orders

Name

get_orders

Description

Parameters

Parameter Label Required Options Description
PageSize PageSize NO
Days Days NO filters results to include transactions within a certain time frame
StartDate Start Date (yyyy-MM-dd) NO
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
filters results to include transactions after the specified begin date (must be at least one day before the specified end date)
EndDate End Date (yyyy-MM-dd) NO
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
filters results to include transactions before the specified end date
Status Order Status NO
Option Value
completed completed
cancelled cancelled
failed failed
filters results by transaction status; completed = successful orders, canceled = declined orders, failed = transaction failed to complete (very uncommon)
Products Products NO filters results to include only transactions involving the specified product ID(s) / product path(s)
Return Show Returned Only NO
Option Value
true true
false false
filters results to include orders with or without returns; response includes returns array with return IDs where applicable
Rebill Rebill Only NO
Option Value
true true
false false
filters results to include only subscription rebill transactions or exclude all subscription rebill transactions
Scope Scope NO
Option Value
all all
live live
test test
filters results to include live transactions, test transactions, or both

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Raw Description
Id DT_WSTR nvarchar(50) 50 False
Reference DT_WSTR nvarchar(50) 50 False
Item_1 DT_WSTR nvarchar(100) 100 False First item from this order
Item_2 DT_WSTR nvarchar(100) 100 False First item from this order
OrderDate DT_DBDATE date False
SubtotalInPayoutCurrency DT_R8 float False
TaxInPayoutCurrency DT_R8 float False
TotalInPayoutCurrency DT_R8 float False
DiscountInPayoutCurrency DT_R8 float False
ProratedTotalInPayoutCurrency DT_R8 float False
Currency DT_WSTR nvarchar(10) 10 False
SubtotalDisplay DT_WSTR nvarchar(50) 50 False
TaxDisplay DT_WSTR nvarchar(50) 50 False
TotalDisplay DT_WSTR nvarchar(50) 50 False
CustomerCompany DT_WSTR nvarchar(255) 255 False
CustomerEmail DT_WSTR nvarchar(255) 255 False
CustomerFirst DT_WSTR nvarchar(255) 255 False
CustomerLast DT_WSTR nvarchar(255) 255 False
CustomerPhone DT_WSTR nvarchar(255) 255 False
CustomerSubscribed DT_BOOL bit False
AddressLine1 DT_WSTR nvarchar(255) 255 False
AddressLine2 DT_WSTR nvarchar(255) 255 False
AddressCity DT_WSTR nvarchar(255) 255 False
AddressCountry DT_WSTR nvarchar(255) 255 False
AddressDisplay DT_WSTR nvarchar(255) 255 False
AddressPostalCode DT_WSTR nvarchar(20) 20 False
AddressRegionCode DT_WSTR nvarchar(20) 20 False
AddressRegion DT_WSTR nvarchar(20) 20 False
AddressRegionDisplay DT_WSTR nvarchar(20) 20 False
BuyerReference DT_WSTR nvarchar(50) 50 False
IpAddress DT_WSTR nvarchar(50) 50 False
Completed DT_BOOL bit False
Changed DT_I8 bigint False
ChangedValue DT_I8 bigint False
ChangedInSeconds DT_I8 bigint False
ChangedDisplay DT_WSTR nvarchar(50) 50 False
ChangedDisplayEmailEnhancements DT_WSTR nvarchar(50) 50 False
ChangedDisplayEmailEnhancementsWithTime DT_WSTR nvarchar(50) 50 False
Language DT_WSTR nvarchar(10) 10 False
Live DT_BOOL bit False
PayoutCurrency DT_WSTR nvarchar(10) 10 False
QuoteId DT_WSTR nvarchar(500) 500 False
InvoiceUrl DT_WSTR nvarchar(500) 500 False
SiteId DT_WSTR nvarchar(50) 50 False
AccountId DT_WSTR nvarchar(50) 50 False
Total DT_R8 float False
TotalInPayoutCurrencyDisplay DT_WSTR nvarchar(50) 50 False
Tax DT_R8 float False
TaxInPayoutCurrencyDisplay DT_WSTR nvarchar(50) 50 False
Subtotal DT_R8 float False
SubtotalInPayoutCurrencyDisplay DT_WSTR nvarchar(50) 50 False
Discount DT_R8 float False
DiscountDisplay DT_WSTR nvarchar(50) 50 False
DiscountInPayoutCurrencyDisplay DT_WSTR nvarchar(50) 50 False
DiscountWithTax DT_R8 float False
DiscountWithTaxDisplay DT_WSTR nvarchar(50) 50 False
DiscountWithTaxInPayoutCurrency DT_R8 float False
DiscountWithTaxInPayoutCurrencyDisplay DT_WSTR nvarchar(50) 50 False
BillDescriptor DT_WSTR nvarchar(50) 50 False
PaymentType DT_WSTR nvarchar(50) 50 False
PaymentCardEnding DT_WSTR nvarchar(8) 8 False
PaymentBank DT_WSTR nvarchar(100) 100 False
PaymentMethodType DT_WSTR nvarchar(50) 50 False
Recipients DT_WSTR nvarchar(2000) 2000 False
Notes DT_WSTR nvarchar(4000) 4000 False
AcquisitionTransactionType DT_WSTR nvarchar(100) 100 False
TaxExemptionData DT_WSTR nvarchar(2000) 2000 False
ProratedCreditTotal DT_R8 float False
ProratedCreditTotalDisplay DT_WSTR nvarchar(50) 50 False
ProratedCreditTotalInPayoutCurrency DT_R8 float False
ProratedCreditTotalInPayoutCurrencyDisplay DT_WSTR nvarchar(50) 50 False
ProratedDebitTotal DT_R8 float False
ProratedDebitTotalDisplay DT_WSTR nvarchar(50) 50 False
ProratedDebitTotalInPayoutCurrency DT_R8 float False
ProratedDebitTotalInPayoutCurrencyDisplay DT_WSTR nvarchar(50) 50 False
ProratedTotal DT_R8 float False
ProratedTotalDisplay DT_WSTR nvarchar(50) 50 False
ProratedTotalInPayoutCurrencyDisplay DT_WSTR nvarchar(50) 50 False
IsScsProratedOrder DT_BOOL bit False
IsScsProratedOrderUpgrade DT_BOOL bit False
LastFourDigits DT_WSTR nvarchar(50) 50 False
PreviousOrderReference DT_WSTR nvarchar(50) 50 False
PreviousOrderInvoiceUrl DT_WSTR nvarchar(500) 500 False
ReturnId_1 DT_WSTR nvarchar(50) 50 False First return in this order
ReturnAmount_1 DT_R8 float False First return amount in local currency for this order
ReturnAmountUSD_1 DT_R8 float False First return amount in USD for this order
SubscriptionId_1 DT_WSTR nvarchar(50) 50 False First subscription in this order
SubscriptionId_2 DT_WSTR nvarchar(50) 50 False Second subscription in this order
SubscriptionId_3 DT_WSTR nvarchar(50) 50 False Third subscription in this order
Tags DT_WSTR nvarchar(4000) 4000 False

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:

Get Orders using API Source

FastSpring
Get Orders
SSIS API Source - Read from table or endpoint

Get Orders using API Destination

FastSpring
Get Orders
SSIS API Destination - Access table or endpoint