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

Input Columns

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