FastSpring Connector
Documentation
Version: 1
Documentation
Home » API Integration Hub » FastSpring Connector » EndPoints > Get Order Items

EndPoint Get Order Items

Name

get_order_items

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
OrderId DT_WSTR nvarchar(100) 100 False
ProductId DT_WSTR nvarchar(255) 255 False
Quantity DT_I8 bigint False
Display DT_WSTR nvarchar(4000) 4000 False
Sku DT_WSTR nvarchar(255) 255 False
ShortDisplay DT_WSTR nvarchar(1000) 1000 False
SubscriptionId DT_WSTR nvarchar(88) 88 False
ImageUrl DT_WSTR nvarchar(1000) 1000 False
SubtotalDisplay DT_WSTR nvarchar(52) 52 False
Subtotal DT_R8 float False
SubtotalInPayoutCurrency DT_R8 float False
SubtotalInPayoutCurrencyDisplay DT_WSTR nvarchar(48) 48 False
AttributesPathFrom DT_WSTR nvarchar(60) 60 False
AttributesPathTo DT_WSTR nvarchar(60) 60 False
AttributesQuantityFrom DT_I8 bigint False
AttributesQuantityTo DT_I8 bigint False
AttributesDisplay DT_WSTR nvarchar(2048) 2048 False
AttributesTotalChange DT_R8 float False
AttributesTotalProratedCharge DT_R8 float False
AttributesTotalProratedCredit DT_R8 float False
AttributesTotalNetCharge DT_R8 float False
AttributesPreviousCharge DT_R8 float False
AttributesUpcomingCharge DT_R8 float False
AttributesUtilizedPrevious DT_R8 float False
AttributesLapsedPrevious DT_R8 float False
Discount DT_R8 float False
DiscountDisplay DT_WSTR nvarchar(36) 36 False
DiscountInPayoutCurrency DT_R8 float False
DiscountInPayoutCurrencyDisplay DT_WSTR nvarchar(36) 36 False
IsSubscription DT_BOOL bit False
ChangeQuantity DT_BOOL bit False
WithholdingsTaxWithholdings DT_BOOL bit False
ProratedItemChangeAmount DT_R8 float False
ProratedItemChangeAmountDisplay DT_WSTR nvarchar(28) 28 False
ProratedItemChangeAmountInPayoutCurrency DT_R8 float False
ProratedItemChangeAmountInPayoutCurrencyDisplay DT_WSTR nvarchar(32) 32 False
ProratedItemProratedCharge DT_R8 float False
ProratedItemProratedChargeDisplay DT_WSTR nvarchar(36) 36 False
ProratedItemProratedChargeInPayoutCurrency DT_R8 float False
ProratedItemProratedChargeInPayoutCurrencyDisplay DT_WSTR nvarchar(36) 36 False
ProratedItemCreditAmount DT_R8 float False
ProratedItemCreditAmountDisplay DT_WSTR nvarchar(36) 36 False
ProratedItemCreditAmountInPayoutCurrency DT_R8 float False
ProratedItemCreditAmountInPayoutCurrencyDisplay DT_WSTR nvarchar(36) 36 False
ProratedItemTaxAmount DT_R8 float False
ProratedItemTaxAmountDisplay DT_WSTR nvarchar(24) 24 False
ProratedItemTaxAmountInPayoutCurrency DT_R8 float False
ProratedItemTaxAmountInPayoutCurrencyDisplay DT_WSTR nvarchar(32) 32 False
ProratedItemTotal DT_R8 float False
ProratedItemTotalDisplay DT_WSTR nvarchar(28) 28 False
ProratedItemTotalInPayoutCurrency DT_R8 float False
ProratedItemTotalInPayoutCurrencyDisplay DT_WSTR nvarchar(32) 32 False
AttributesMigratedProductId DT_WSTR nvarchar(88) 88 False
AttributesClassicProduct DT_WSTR nvarchar(1068) 1068 False
IsAddon DT_BOOL bit False
Reference DT_WSTR nvarchar(100) 100 False
BuyerReference DT_WSTR nvarchar(100) 100 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
OrderDate DT_DBDATE date False
ChangedDisplayEmailEnhancements DT_WSTR nvarchar(50) 50 False
ChangedDisplayEmailEnhancementsWithTime DT_WSTR nvarchar(96) 96 False
Language DT_WSTR nvarchar(8) 8 False
Live DT_BOOL bit False
Currency DT_WSTR nvarchar(12) 12 False
PayoutCurrency DT_WSTR nvarchar(12) 12 False
QuoteId DT_WSTR nvarchar(1020) 1020 False
InvoiceUrl DT_WSTR nvarchar(440) 440 False
SiteId DT_WSTR nvarchar(50) 50 False
AccountId DT_WSTR nvarchar(88) 88 False
Total DT_R8 float False
TotalDisplay DT_WSTR nvarchar(50) 50 False
TotalInPayoutCurrency DT_R8 float False
TotalInPayoutCurrencyDisplay DT_WSTR nvarchar(50) 50 False
Tax DT_R8 float False
TaxDisplay DT_WSTR nvarchar(50) 50 False
TaxInPayoutCurrency DT_R8 float False
TaxInPayoutCurrencyDisplay DT_WSTR nvarchar(50) 50 False
OrderSubtotal DT_R8 float False
OrderSubtotalDisplay DT_WSTR nvarchar(50) 50 False
OrderSubtotalInPayoutCurrency DT_R8 float False
OrderSubtotalInPayoutCurrencyDisplay DT_WSTR nvarchar(50) 50 False
OrderDiscount DT_R8 float False
OrderDiscountDisplay DT_WSTR nvarchar(50) 50 False
OrderDiscountInPayoutCurrency DT_R8 float False
OrderDiscountInPayoutCurrencyDisplay DT_WSTR nvarchar(50) 50 False
OrderDiscountWithTax DT_R8 float False
OrderDiscountWithTaxDisplay DT_WSTR nvarchar(50) 50 False
OrderDiscountWithTaxInPayoutCurrency DT_R8 float False
OrderDiscountWithTaxInPayoutCurrencyDisplay DT_WSTR nvarchar(50) 50 False
BillDescriptor DT_WSTR nvarchar(50) 50 False
PaymentType DT_WSTR nvarchar(50) 50 False
PaymentCardEnding DT_WSTR nvarchar(50) 50 False
CustomerFirst DT_WSTR nvarchar(50) 50 False
CustomerLast DT_WSTR nvarchar(50) 50 False
CustomerEmail DT_WSTR nvarchar(255) 255 False
CustomerCompany DT_WSTR nvarchar(255) 255 False
CustomerPhone DT_WSTR nvarchar(100) 100 False
CustomerSubscribed DT_BOOL bit False
AddressCity DT_WSTR nvarchar(255) 255 False
AddressRegionCode DT_WSTR nvarchar(10) 10 False
AddressRegionDisplay DT_WSTR nvarchar(255) 255 False
AddressRegion DT_WSTR nvarchar(50) 50 False
AddressPostalCode DT_WSTR nvarchar(20) 20 False
AddressCountry DT_WSTR nvarchar(255) 255 False
AddressDisplay DT_WSTR nvarchar(128) 128 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.