|
Changes since the last release |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ebay.sdk.ApiCall
com.ebay.sdk.call.GetOrderTransactionsCall
public class GetOrderTransactionsCall
Wrapper class of the GetOrderTransactions call of eBay SOAP API.
Title: SOAP API wrapper library.
Description: Contains wrapper classes for eBay SOAP APIs.
Copyright: Copyright (c) 2009
Company: eBay Inc.
ItemTransactionIDArray
- This container is used if the seller wants to search for one or more specific 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 a OrderLineItemID value, or with a SKU value (if a SKU exists for the order line item).
OrderIDArray
- This container is used if the seller wants to search for one or more specific orders. An OrderID field is required for each order that is to be retrieved. Up to 20 OrderID fields can be used.
Platform
- Note: This field's purpose is to allow the seller to retrieve only eBay listings or only Half.com listings instead of both order types. Since API support for Half.com listings is being deprecated, this field is no longer necessary to use since eBay orders will be the only orders that are retrieved.
The default behavior of GetOrderTransactions is to retrieve all orders originating from eBay.com and Half.com. If the user wants to retrieve only eBay.com order line items or Half.com order line items, this filter can be used to perform that function. Inserting eBay
into this field will restrict retrieved order line items to those originating on eBay.com, and inserting Half
into this field will restrict retrieved order line items to those originating on Half.com.
IncludeFinalValueFees
- This field is included and set to true
if the seller wishes to include the Final Value Fee (FVF) for each order in the response. A Final Value Fee is calculated based on total amount of the sale, including the final price of the item and shipping/handling charges. This fee is charged to a seller's account immediately upon creation of an order line item.
ReturnedOrderArray
- This container consists of an array of eBay orders that match the input criteria that was passed into the call request.
Field Summary |
---|
Fields inherited from class com.ebay.sdk.ApiCall |
---|
apiException, sendReqListeners |
Constructor Summary | |
---|---|
GetOrderTransactionsCall()
Constructor. |
|
GetOrderTransactionsCall(ApiContext apiContext)
Constructor. |
Method Summary | |
---|---|
Boolean |
getIncludeFinalValueFees()
Gets the GetOrderTransactionsRequestType.includeFinalValueFees. |
ItemTransactionIDArrayType |
getItemTransactionIDArray()
Gets the GetOrderTransactionsRequestType.itemTransactionIDArray. |
OrderIDArrayType |
getOrderIDArray()
Gets the GetOrderTransactionsRequestType.orderIDArray. |
OrderArrayType |
getOrderTransactions()
The base request type for the GetOrderTransactions call. |
TransactionPlatformCodeType |
getPlatform()
Gets the GetOrderTransactionsRequestType.platform. |
OrderArrayType |
getReturnedOrderArray()
Valid after executing the API. |
void |
setIncludeFinalValueFees(Boolean includeFinalValueFees)
Sets the GetOrderTransactionsRequestType.includeFinalValueFees. |
void |
setItemTransactionIDArray(ItemTransactionIDArrayType itemTransactionIDArray)
Sets the GetOrderTransactionsRequestType.itemTransactionIDArray. |
void |
setOrderIDArray(OrderIDArrayType orderIDArray)
Sets the GetOrderTransactionsRequestType.orderIDArray. |
void |
setPlatform(TransactionPlatformCodeType platform)
Sets the GetOrderTransactionsRequestType.platform. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public GetOrderTransactionsCall()
public GetOrderTransactionsCall(ApiContext apiContext)
apiContext
- The ApiContext object to be used to make the call.Method Detail |
---|
public OrderArrayType getOrderTransactions() throws ApiException, SdkException, Exception
ApiException
SdkException
Exception
public Boolean getIncludeFinalValueFees()
public void setIncludeFinalValueFees(Boolean includeFinalValueFees)
includeFinalValueFees
- Booleanpublic ItemTransactionIDArrayType getItemTransactionIDArray()
public void setItemTransactionIDArray(ItemTransactionIDArrayType itemTransactionIDArray)
itemTransactionIDArray
- ItemTransactionIDArrayTypepublic OrderIDArrayType getOrderIDArray()
public void setOrderIDArray(OrderIDArrayType orderIDArray)
orderIDArray
- OrderIDArrayTypepublic TransactionPlatformCodeType getPlatform()
public void setPlatform(TransactionPlatformCodeType platform)
platform
- TransactionPlatformCodeTypepublic OrderArrayType getReturnedOrderArray()
|
Changes since the last release |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The information contained in this document is proprietary and confidential.
Use of this information and the eBay API requires a Non-Disclosure Agreement (NDA) between the user and eBay Inc.
For information regarding a qualifying NDA, contact Developer Relations:
developer-relations@ebay.com
© 2004-2009 eBay Inc. All rights reserved.