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

Input Columns

Label DataType Length Raw Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.