EndPoint Get Account Orders (For all accounts)

Name

get_account_orders

Description

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	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 Account Orders (For all accounts) using API Source

FastSpring

Get Account Orders (For all accounts)

SSIS API Source - Read from table or endpoint

Get Account Orders (For all accounts) using API Destination

FastSpring

Get Account Orders (For all accounts)