Overview 
Namespace 
WSDL 
Schema 
 Component 
Index 
PREV C-TYPE   NEXT C-TYPE
FRAMES   NO FRAMES NS-Bindings
SUMMARY: XML REP | DERIVED | USE
DETAIL: DESC | XML SRC | TYPE | ATTR | CHILD
eBay Trading API
complexType "ns:GetOrderTransactionsRequestType"
Namespace:
urn:ebay:apis:eBLBaseComponents
Content:
complex, 14 elements, elem. wildcard
Defined:
globally in Schema in ebaySvc.wsdl; see XML source
Includes:
definitions of 4 elements
Used:
at 1 location
Component Diagram
XML Representation Summary
<...>
   
Content: 
ns:DetailLevel*, ns:ErrorLanguage?, ns:MessageID?, ns:Version?, ns:EndUserIP?, ns:ErrorHandling?, ns:InvocationID?, ns:OutputSelector*, ns:WarningLevel?, ns:BotBlock?, {any}*, ns:ItemTransactionIDArray?, ns:OrderIDArray?, ns:Platform?, ns:IncludeFinalValueFees?
</...>
All Direct / Indirect Based Elements (1):
ns:GetOrderTransactionsRequest
Known Usage Locations
Annotation
The base request type for the GetOrderTransactions call. This call retrieves detailed information about one or more orders or order line items created (or modified) in the last 90 days.

Unlike GetOrders, which can be used to retrieve specific orders, or orders created (or modified) within a specific time period, the GetOrderTransactions call only supports the retrieval of specific orders and/or order line items.
Type Definition Detail
Type Derivation Tree
ns:AbstractRequestType (extension)
  ns:GetOrderTransactionsRequestType
XML Source (w/o annotations (5); see within schema source)
<xs:complexType name="GetOrderTransactionsRequestType">
<xs:complexContent>
<xs:extension base="ns:AbstractRequestType">
<xs:sequence>
<xs:element minOccurs="0" name="ItemTransactionIDArray" type="ns:ItemTransactionIDArrayType"/>
<xs:element minOccurs="0" name="OrderIDArray" type="ns:OrderIDArrayType"/>
<xs:element minOccurs="0" name="Platform" type="ns:TransactionPlatformCodeType"/>
<xs:element minOccurs="0" name="IncludeFinalValueFees" type="xs:boolean"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
Content Element Detail (all declarations defined in this component; 4/15)
ns:IncludeFinalValueFees
Type:
xs:boolean, predefined, simple content
This field is included and set to true if the user wants to view the Final Value Fee (FVF) for all order line items in the response. The Final Value Fee is returned in the Transaction.FinalValueFee field. The Final Value Fee is assessed right after the creation of an order line item.

Note: The calculation of the Final Value Fee is changing for managed payments sellers, so the value returned in the FinalValueFee fields for each order line item in the response should only be considered as estimated values. The getTransactions method of the Finances API can be used to get accurate Final Value Fee values.

See the Selling fees for managed payments sellers help page for more information about how Final Value Fees are changing for managed payments sellers.
XML Representation Summary
<ns:IncludeFinalValueFees>
   
Content: 
{ xs:boolean }
</ns:IncludeFinalValueFees>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="IncludeFinalValueFees" type="xs:boolean"/>
ns:ItemTransactionIDArray
Type:
ns:ItemTransactionIDArrayType, complex content
This container is used if the seller wants to retrieve for one or more order line items. An ItemTransactionID container is required for each order line item that is to be retrieved. An order line item can be identified with an ItemID/TransactionID pair, with an OrderLineItemID value, or with a SKU value (if a SKU is defined for the order line item).
Component Diagram
XML Representation Summary
<ns:ItemTransactionIDArray>
   
Content: 
ns:ItemTransactionID*
</ns:ItemTransactionIDArray>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="ItemTransactionIDArray" type="ns:ItemTransactionIDArrayType"/>
ns:OrderIDArray
Type:
ns:OrderIDArrayType, complex content
This container is used if the seller wants to search for one or more orders. An OrderID field is required for each order that is to be retrieved. Up to 20 OrderID fields can be used.

Note: As of June 2019, eBay has changed the format of order identifier values. The new format is a non-parsable string, globally unique across all eBay marketplaces, and consistent for both single line item and multiple line item orders. Unlike in the past, instead of just being known and exposed to the seller, these unique order identifiers will also be known and used/referenced by the buyer and eBay customer support.

For developers and sellers who are already integrated with the Trading API's order management calls, this change shouldn't impact your integration unless you parse the existing order identifiers (e.g., OrderID or OrderLineItemID), or otherwise infer meaning from the format (e.g., differentiating between a single line item order versus a multiple line item order). Because we realize that some integrations may have logic that is dependent upon the old identifier format, eBay is rolling out this Trading API change with version control to support a transition period of approximately 9 months before applications must switch to the new format completely.

During the transition period, for developers/sellers using a Trading WSDL older than Version 1113, they can use the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header in API calls to control whether the new or old OrderID format is returned in call response payloads. To get the new OrderID format, the value of the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header must be set to 1113. During the transition period and even after, the new and old OrderID formats will still be supported/accepted in all Trading API call request payloads. After the transition period (which will be announced), only the new OrderID format will be returned in all Trading API call response payloads, regardless of the Trading WSDL version used or specified compatibility level.
Note: For sellers integrated with the new order ID format, please note that the identifier for an order will change as it goes from unpaid to paid status. Sellers can check to see if an order has been paid by looking for a value of 'Complete' in the CheckoutStatus.Status field in the response of GetOrders or GetOrderTransactions call, or in the Status.CompleteStatus field in the response of GetItemTransactions or GetSellerTransactions call. Sellers should not fulfill orders until buyer has made payment. When using a GetOrders or GetOrderTransactions call to retrieve specific order(s), either of these order IDs (paid or unpaid status) can be used to retrieve an order.
Component Diagram
XML Representation Summary
<ns:OrderIDArray>
   
Content: 
ns:OrderID*
</ns:OrderIDArray>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="OrderIDArray" type="ns:OrderIDArrayType"/>
ns:Platform
Type:
ns:TransactionPlatformCodeType, simple content
Note: This field should no longer be used since its sole purpose was to allow the seller to filter between eBay orders and Half.com orders, and the Half.com site no longer exists.
XML Representation Summary
<ns:Platform>
   
Content: 
{ enumeration of xs:token }
</ns:Platform>
Simple Content
Enumeration:
"eBay"
 - 
This value indicates the purchase occurred on an eBay marketplace site.
"Express"
 - 
Note: eBay Express no longer exists. The order line item was created on the eBay Express site.
"Half"
 - 
Note: Half.com listings will no longer be supported in APIs. The order line item was created on Half.com site.
"Shopping"
 - 
Note: Shopping.com listings are no longer supported in APIs. The order line item was created on the Shopping.com site.
"WorldOfGood"
 - 
Note: World Of Good is no longer associated with eBay. The order line item was created on the WorldOfGood site.
"CustomCode"
 - 
Reserved for future use.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="Platform" type="ns:TransactionPlatformCodeType"/>
Overview 
Namespace 
WSDL 
Schema 
 Component 
Index 
PREV C-TYPE   NEXT C-TYPE
FRAMES   NO FRAMES NS-Bindings
SUMMARY: XML REP | DERIVED | USE
DETAIL: DESC | XML SRC | TYPE | ATTR | CHILD
eBay Trading API
WSDL documentation generated with FlexDoc/XML 1.13 using FlexDoc/XML WSDLDoc 1.2.5 template set. All XSD diagrams generated by FlexDoc/XML DiagramKit.