Reference

Endpoint Get Order Items

Name

get_order_items

Description

Related Tables

OrderItems

Parameters

Parameter Required Options
Name: PageSize

Label: PageSize
Name: Days

Label: Days

filters results to include transactions within a certain time frame
Name: StartDate

Label: Start Date (yyyy-MM-dd)

filters results to include transactions after the specified begin date (must be at least one day before the specified end date)
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
Name: EndDate

Label: End Date (yyyy-MM-dd)

filters results to include transactions before the specified end date
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
Name: Status

Label: Order Status

filters results by transaction status; completed = successful orders, canceled = declined orders, failed = transaction failed to complete (very uncommon)
Option Value
completed completed
cancelled cancelled
failed failed
Name: Products

Label: Products

filters results to include only transactions involving the specified product ID(s) / product path(s)
Name: Return

Label: Show Returned Only

filters results to include orders with or without returns; response includes returns array with return IDs where applicable
Option Value
true true
false false
Name: Rebill

Label: Rebill Only

filters results to include only subscription rebill transactions or exclude all subscription rebill transactions
Option Value
true true
false false
Name: Scope

Label: Scope

filters results to include live transactions, test transactions, or both
Option Value
all all
live live
test test

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
OrderId DT_WSTR nvarchar(100) 100
ProductId DT_WSTR nvarchar(255) 255
Quantity DT_I8 bigint
Display DT_WSTR nvarchar(4000) 4000
Sku DT_WSTR nvarchar(255) 255
ShortDisplay DT_WSTR nvarchar(1000) 1000
SubscriptionId DT_WSTR nvarchar(88) 88
ImageUrl DT_WSTR nvarchar(1000) 1000
SubtotalDisplay DT_WSTR nvarchar(52) 52
Subtotal DT_R8 float
SubtotalInPayoutCurrency DT_R8 float
SubtotalInPayoutCurrencyDisplay DT_WSTR nvarchar(48) 48
AttributesPathFrom DT_WSTR nvarchar(60) 60
AttributesPathTo DT_WSTR nvarchar(60) 60
AttributesQuantityFrom DT_I8 bigint
AttributesQuantityTo DT_I8 bigint
AttributesDisplay DT_WSTR nvarchar(2048) 2048
AttributesTotalChange DT_R8 float
AttributesTotalProratedCharge DT_R8 float
AttributesTotalProratedCredit DT_R8 float
AttributesTotalNetCharge DT_R8 float
AttributesPreviousCharge DT_R8 float
AttributesUpcomingCharge DT_R8 float
AttributesUtilizedPrevious DT_R8 float
AttributesLapsedPrevious DT_R8 float
Discount DT_R8 float
DiscountDisplay DT_WSTR nvarchar(36) 36
DiscountInPayoutCurrency DT_R8 float
DiscountInPayoutCurrencyDisplay DT_WSTR nvarchar(36) 36
IsSubscription DT_BOOL bit
ChangeQuantity DT_BOOL bit
WithholdingsTaxWithholdings DT_BOOL bit
ProratedItemChangeAmount DT_R8 float
ProratedItemChangeAmountDisplay DT_WSTR nvarchar(28) 28
ProratedItemChangeAmountInPayoutCurrency DT_R8 float
ProratedItemChangeAmountInPayoutCurrencyDisplay DT_WSTR nvarchar(32) 32
ProratedItemProratedCharge DT_R8 float
ProratedItemProratedChargeDisplay DT_WSTR nvarchar(36) 36
ProratedItemProratedChargeInPayoutCurrency DT_R8 float
ProratedItemProratedChargeInPayoutCurrencyDisplay DT_WSTR nvarchar(36) 36
ProratedItemCreditAmount DT_R8 float
ProratedItemCreditAmountDisplay DT_WSTR nvarchar(36) 36
ProratedItemCreditAmountInPayoutCurrency DT_R8 float
ProratedItemCreditAmountInPayoutCurrencyDisplay DT_WSTR nvarchar(36) 36
ProratedItemTaxAmount DT_R8 float
ProratedItemTaxAmountDisplay DT_WSTR nvarchar(24) 24
ProratedItemTaxAmountInPayoutCurrency DT_R8 float
ProratedItemTaxAmountInPayoutCurrencyDisplay DT_WSTR nvarchar(32) 32
ProratedItemTotal DT_R8 float
ProratedItemTotalDisplay DT_WSTR nvarchar(28) 28
ProratedItemTotalInPayoutCurrency DT_R8 float
ProratedItemTotalInPayoutCurrencyDisplay DT_WSTR nvarchar(32) 32
AttributesMigratedProductId DT_WSTR nvarchar(88) 88
AttributesClassicProduct DT_WSTR nvarchar(1068) 1068
IsAddon DT_BOOL bit
Reference DT_WSTR nvarchar(100) 100
BuyerReference DT_WSTR nvarchar(100) 100
IpAddress DT_WSTR nvarchar(50) 50
Completed DT_BOOL bit
Changed DT_I8 bigint
ChangedValue DT_I8 bigint
ChangedInSeconds DT_I8 bigint
ChangedDisplay DT_WSTR nvarchar(50) 50
OrderDate DT_DBDATE date
ChangedDisplayEmailEnhancements DT_WSTR nvarchar(50) 50
ChangedDisplayEmailEnhancementsWithTime DT_WSTR nvarchar(96) 96
Language DT_WSTR nvarchar(8) 8
Live DT_BOOL bit
Currency DT_WSTR nvarchar(12) 12
PayoutCurrency DT_WSTR nvarchar(12) 12
QuoteId DT_WSTR nvarchar(1020) 1020
InvoiceUrl DT_WSTR nvarchar(440) 440
SiteId DT_WSTR nvarchar(50) 50
AccountId DT_WSTR nvarchar(88) 88
Total DT_R8 float
TotalDisplay DT_WSTR nvarchar(50) 50
TotalInPayoutCurrency DT_R8 float
TotalInPayoutCurrencyDisplay DT_WSTR nvarchar(50) 50
Tax DT_R8 float
TaxDisplay DT_WSTR nvarchar(50) 50
TaxInPayoutCurrency DT_R8 float
TaxInPayoutCurrencyDisplay DT_WSTR nvarchar(50) 50
OrderSubtotal DT_R8 float
OrderSubtotalDisplay DT_WSTR nvarchar(50) 50
OrderSubtotalInPayoutCurrency DT_R8 float
OrderSubtotalInPayoutCurrencyDisplay DT_WSTR nvarchar(50) 50
OrderDiscount DT_R8 float
OrderDiscountDisplay DT_WSTR nvarchar(50) 50
OrderDiscountInPayoutCurrency DT_R8 float
OrderDiscountInPayoutCurrencyDisplay DT_WSTR nvarchar(50) 50
OrderDiscountWithTax DT_R8 float
OrderDiscountWithTaxDisplay DT_WSTR nvarchar(50) 50
OrderDiscountWithTaxInPayoutCurrency DT_R8 float
OrderDiscountWithTaxInPayoutCurrencyDisplay DT_WSTR nvarchar(50) 50
BillDescriptor DT_WSTR nvarchar(50) 50
PaymentType DT_WSTR nvarchar(50) 50
PaymentCardEnding DT_WSTR nvarchar(50) 50
CustomerFirst DT_WSTR nvarchar(50) 50
CustomerLast DT_WSTR nvarchar(50) 50
CustomerEmail DT_WSTR nvarchar(255) 255
CustomerCompany DT_WSTR nvarchar(255) 255
CustomerPhone DT_WSTR nvarchar(100) 100
CustomerSubscribed DT_BOOL bit
AddressCity DT_WSTR nvarchar(255) 255
AddressRegionCode DT_WSTR nvarchar(10) 10
AddressRegionDisplay DT_WSTR nvarchar(255) 255
AddressRegion DT_WSTR nvarchar(50) 50
AddressPostalCode DT_WSTR nvarchar(20) 20
AddressCountry DT_WSTR nvarchar(255) 255
AddressDisplay DT_WSTR nvarchar(128) 128
If the column you are looking for is missing, consider customizing FastSpring Connector.

Input Columns

Label Data Type (SSIS) Data Type (SQL) Length 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 or in API Destination SSIS Data Flow components to read or write data.

API Source

This Endpoint belongs to the OrderItems table, therefore it is better to use it, instead of accessing the endpoint directly:

API Source - FastSpring
Read / write FastSpring data related to Orders, Subscriptions, Quotes, Products, Accounts and more without coding.
FastSpring
OrderItems
There are no parameters to configure.
SSIS API Source - Read from table or endpoint

API Destination

This Endpoint belongs to the OrderItems table, therefore it is better to use it, instead of accessing the endpoint directly. Use this table and table-operation pair to get order items:

API Destination - FastSpring
Read / write FastSpring data related to Orders, Subscriptions, Quotes, Products, Accounts and more without coding.
FastSpring
OrderItems
Select
There are no parameters to configure.
SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Get OrderItems 

SELECT * FROM OrderItems

get_order_items endpoint belongs to OrderItems table(s), and can therefore be used via those table(s).

SQL Server

Use these SQL queries in SQL Server after you create a data source in Data Gateway:

Get OrderItems 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM OrderItems';

EXEC (@MyQuery) AT [LS_TO_FASTSPRING_IN_GATEWAY];

get_order_items endpoint belongs to OrderItems table(s), and can therefore be used via those table(s).