Changes since
the last release

com.ebay.sdk.call
Class GetItemTransactionsCall

java.lang.Object
  extended by com.ebay.sdk.ApiCall
      extended by com.ebay.sdk.call.GetItemTransactionsCall

public class GetItemTransactionsCall
extends ApiCall

Wrapper class of the GetItemTransactions 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.


Input property: ItemID - Unique identifier for an eBay listing. A listing can have multiple order line items, but only one ItemID. When you use ItemID alone, eBay returns all order line items that are associated with the ItemID. If you pair ItemID with a specific TransactionID, data on a specific order line item is returned. If OrderLineItemID is specified in the request, any ItemID/TransactionID pair specified in the same request will be ignored.

Note: GetItemTransactions doesn't support SKU as an input because this call requires an identifier that is unique across your active and ended listings. Even when InventoryTrackingMethod is set to SKU in a listing, the SKU is only unique across your active listings (not your ended listings). To retrieve order line items by SKU, use GetSellerTransactions or GetOrderTransactions instead.
Input property: ModifiedTimeFilter - Helper wrapper to set GetItemTransactionsRequestType ModTimeFrom, ModTimeTo: TimeFrom sets GetItemTransactionsRequestType.ModTimeFrom: The ModTimeFrom and ModTimeTo fields specify a date range for retrieving order line items associated with the specified ItemID. The ModTimeFrom field is the starting date range. All of the listing's order line items that were last modified within this date range are returned in the output. The maximum date range that may be specified is 30 days. This value cannot be set back more than 90 days in the past, as this call cannot retrieve sales older than 90 days old. The maximum date range that may be specified is 30 days. This field is not applicable if a specific TransactionID or OrderLineItemID is included in the request or if the NumberOfDays date filter is used.

If you don't specify a ModTimeFrom/ModTimeTo filter, the NumberOfDays time filter is used and it defaults to 30 (days). TimeTo sets GetItemTransactionsRequestType.ModTimeTo: The ModTimeFrom and ModTimeTo fields specify a date range for retrieving order line items associated with the specified ItemID. The ModTimeTo field is the ending date range. All eBay order line items that were last modified within this date range are returned in the output. The maximum date range that may be specified is 30 days. If the ModTimeFrom field is used and the ModTimeTo field is omitted, the ModTimeTo value defaults to the present time or to 30 days past the ModTimeFrom value (if ModTimeFrom value is more than 30 days in the past). This field is not applicable if a specific TransactionID or OrderLineItemID is included in the request or if the NumberOfDays date filter is used.

If you don't specify a ModTimeFrom/ModTimeTo filter, the NumberOfDays time filter is used and it defaults to 30 (days).
Input property: TransactionID - Include a TransactionID field in the request if you want to retrieve the data for a specific order line item. If a TransactionID is provided, any specified time filter is ignored.
Input property: Pagination - Child elements control pagination of the output. Use the EntriesPerPage property to control the number of order line items to return per call and the PageNumber property to specify the specific page of data to return. If multiple pages of order line items are returned based on input criteria and Pagination properties, GetItemTransactions will need to be called multiple times (with the PageNumber value being increased by 1 each time) to scroll through all results.
Input property: IncludeFinalValueFee - Indicates whether to include 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.
Input property: IncludeContainingOrder - Include this field and set it to True if you want the ContainingOrder container to be returned in the response under each Transaction node. For single line item orders, the ContainingOrder.OrderID value takes the value of the OrderLineItemID value for the order line item. For Combined Invoice orders, the ContainingOrder.OrderID value will be shared by at least two order line items that are part of the same order.
Input property: 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 GetItemTransactions is to retrieve all order line items originating from eBay.com and Half.com. If the user wants to retrieve only eBay.com order line items or only 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.
Input property: NumberOfDays - This time filter specifies the number of days (24-hour periods) in the past to search for order line items. All eBay order line items that were either created or modified within this period are returned in the response. If specified, NumberOfDays will override any date range specified with the ModTimeFrom/ModTimeTo time filters. This field is not applicable if a specific TransactionID or OrderLineItemID is included in the request.
Input property: IncludeVariations - If included in the request and set to True, all variations defined for the item are returned at the root level, including variations that have no sales. If not included in the request or set to false, the variations with sales are still returned in separate Transaction nodes. This information is intended to help sellers to reconcile their local inventory with eBay's records, while processing order line items (without requiring a separate call to GetItem).
Input property: OrderLineItemID - A unique identifier for an eBay order line item. This field is created as soon as there is a commitment to buy from the seller, and its value is based upon the concatenation of ItemID and TransactionID, with a hyphen in between these two IDs. If you want to retrieve data on a specific order line item, you can use an OrderLineItemID value in the request instead of the ItemID/TransactionID pair. If an OrderLineItemID is provided, any specified time filter is ignored.
Output property: PaginationResult - Contains the total number of pages (TotalNumberOfPages) and the total number of entries (TotalNumberOfEntries) that could be returned given repeated calls that use the same selection criteria as the call that returned this response.
Output property: HasMoreTransactions - Indicates whether there are additional order line items to retrieve. That is, indicates whether more pages of data are available to be returned, given the filters that were specified in the request. Returns false for the last page of data.
Output property: ReturnedTransactionsPerPage - Number of order line items returned per page (per call). May be a higher value than ReturnedTransactionCountActual if the page returned is the last page and more than one page of data exists.
Output property: ReturnedPageNumber - Page number for the page of order line items the response returned.
Output property: ReturnedTransactionCountActual - Number of order line items retrieved in the current page of results just returned. May be a lower value than TransactionsPerPage if the page returned is the last page and more than one page of data exists.
Output property: Item - Item object that spawned the order line item. It is a purchase from this item's listing that the order line item represents.
Output property: ReturnedTransactions - List of Transaction objects representing the order line items resulting from the listing. Each Transaction object contains the data for one purchase (of one or more items in the same listing). The Transaction.Item field is not returned because the Item object is returned at the root level of the response. See the reference guide for more information about the fields that are returned.
Output property: PayPalPreferred - Indicates whether the item's seller has the preference enabled that shows that the seller prefers PayPal as the method of payment for an item. This preference is indicated on an item's View Item page and is intended to influence a buyer to use PayPal to pay for the item.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
GetItemTransactionsCall()
          Constructor.
GetItemTransactionsCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 TransactionType[] getEntireItemTransactions()
          Get all item transactions in specified date range.
 boolean getHasMoreTransactions()
          Valid after executing the API.
 java.lang.Boolean getIncludeContainingOrder()
          Gets the GetItemTransactionsRequestType.includeContainingOrder.
 java.lang.Boolean getIncludeFinalValueFee()
          Gets the GetItemTransactionsRequestType.includeFinalValueFee.
 java.lang.Boolean getIncludeVariations()
          Gets the GetItemTransactionsRequestType.includeVariations.
 ItemType getItem()
          Valid after executing the API.
 java.lang.String getItemID()
          Gets the GetItemTransactionsRequestType.itemID.
 TransactionType[] getItemTransactions()
          Retrieves order line item information for a specified ItemID.
 TransactionType[] getItemTransactions(java.lang.String itemID, TimeFilter modifiedTimeFilter)
          Execute the API call.
 TimeFilter getModifiedTimeFilter()
          Gets the GetItemTransactionsRequestType.modifiedTimeFilter.
 java.lang.Integer getNumberOfDays()
          Gets the GetItemTransactionsRequestType.numberOfDays.
 java.lang.String getOrderLineItemID()
          Gets the GetItemTransactionsRequestType.orderLineItemID.
 PaginationType getPagination()
          Gets the GetItemTransactionsRequestType.pagination.
 PaginationResultType getPaginationResult()
          Valid after executing the API.
 boolean getPayPalPreferred()
          Valid after executing the API.
 TransactionPlatformCodeType getPlatform()
          Gets the GetItemTransactionsRequestType.platform.
 java.lang.Integer getReturnedPageNumber()
          Valid after executing the API.
 int getReturnedTransactionCountActual()
          Valid after executing the API.
 TransactionType[] getReturnedTransactions()
          Valid after executing the API.
 java.lang.Integer getReturnedTransactionsPerPage()
          Valid after executing the API.
 java.lang.String getTransactionID()
          Gets the GetItemTransactionsRequestType.transactionID.
 void setIncludeContainingOrder(java.lang.Boolean includeContainingOrder)
          Sets the GetItemTransactionsRequestType.includeContainingOrder.
 void setIncludeFinalValueFe(java.lang.Boolean includeFinalValueFee)
          Backward compatible function - do not use
 void setIncludeFinalValueFee(java.lang.Boolean includeFinalValueFee)
          Sets the GetItemTransactionsRequestType.includeFinalValueFee.
 void setIncludeVariations(java.lang.Boolean includeVariations)
          Sets the GetItemTransactionsRequestType.includeVariations.
 void setItemID(java.lang.String itemID)
          Sets the GetItemTransactionsRequestType.itemID.
 void setModifiedTimeFilter(TimeFilter modifiedTimeFilter)
          Sets the GetItemTransactionsRequestType.modifiedTimeFilter.
 void setNumberOfDays(java.lang.Integer numberOfDays)
          Sets the GetItemTransactionsRequestType.numberOfDays.
 void setOrderLineItemID(java.lang.String orderLineItemID)
          Sets the GetItemTransactionsRequestType.orderLineItemID.
 void setPagination(PaginationType pagination)
          Sets the GetItemTransactionsRequestType.pagination.
 void setPlatform(TransactionPlatformCodeType platform)
          Sets the GetItemTransactionsRequestType.platform.
 void setTransactionID(java.lang.String transactionID)
          Sets the GetItemTransactionsRequestType.transactionID.
 
Methods inherited from class com.ebay.sdk.ApiCall
addDetailLevel, addSendRequestListener, execute, executeByApiName, getApiContext, getApiException, getBotBlock, getCallRetry, getDetailLevel, getEnableCompression, getEndUserIP, getErrorHandling, getInvocationID, getMessageID, getOutputSelector, getRequestXml, getResponseObject, getResponseXml, getSite, getWarningLevel, hasError, hasWarning, isEnableoAuthTokenHTTPHeader, removeSendRequestListener, setApiContext, setBotBlock, setCallRetry, setDetailLevel, setEnableCompression, setEnableoAuthTokenHTTPHeader, setEndUserIP, setErrorHandling, setInvocationID, setMessageID, setOutputSelector, setSite, setWarningLevel
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GetItemTransactionsCall

public GetItemTransactionsCall()
Constructor.


GetItemTransactionsCall

public GetItemTransactionsCall(ApiContext apiContext)
Constructor.

Parameters:
apiContext - The ApiContext object to be used to make the call.
Method Detail

getItemTransactions

public TransactionType[] getItemTransactions()
                                      throws ApiException,
                                             SdkException,
                                             java.lang.Exception
Retrieves order line item information for a specified ItemID. The call returns zero, one, or multiple order line items, depending on the number of items sold from the listing.

You can retrieve order line item data for a specific time range or number of days. If you don't specify a range or number of days, order line item data will be returned for the past 30 days. This call cannot retrieve sales older than 90 days old.

Returns:
The TransactionType[] object.
Throws:
ApiException
SdkException
java.lang.Exception

getIncludeContainingOrder

public java.lang.Boolean getIncludeContainingOrder()
Gets the GetItemTransactionsRequestType.includeContainingOrder.

Returns:
Boolean

setIncludeContainingOrder

public void setIncludeContainingOrder(java.lang.Boolean includeContainingOrder)
Sets the GetItemTransactionsRequestType.includeContainingOrder.

Parameters:
includeContainingOrder - Boolean

getIncludeFinalValueFee

public java.lang.Boolean getIncludeFinalValueFee()
Gets the GetItemTransactionsRequestType.includeFinalValueFee.

Returns:
Boolean

setIncludeFinalValueFee

public void setIncludeFinalValueFee(java.lang.Boolean includeFinalValueFee)
Sets the GetItemTransactionsRequestType.includeFinalValueFee.

Parameters:
includeFinalValueFee - Boolean

getIncludeVariations

public java.lang.Boolean getIncludeVariations()
Gets the GetItemTransactionsRequestType.includeVariations.

Returns:
Boolean

setIncludeVariations

public void setIncludeVariations(java.lang.Boolean includeVariations)
Sets the GetItemTransactionsRequestType.includeVariations.

Parameters:
includeVariations - Boolean

getItemID

public java.lang.String getItemID()
Gets the GetItemTransactionsRequestType.itemID.

Returns:
String

setItemID

public void setItemID(java.lang.String itemID)
Sets the GetItemTransactionsRequestType.itemID.

Parameters:
itemID - String

getModifiedTimeFilter

public TimeFilter getModifiedTimeFilter()
Gets the GetItemTransactionsRequestType.modifiedTimeFilter.

Returns:
TimeFilter

setModifiedTimeFilter

public void setModifiedTimeFilter(TimeFilter modifiedTimeFilter)
Sets the GetItemTransactionsRequestType.modifiedTimeFilter.

Parameters:
modifiedTimeFilter - TimeFilter

getNumberOfDays

public java.lang.Integer getNumberOfDays()
Gets the GetItemTransactionsRequestType.numberOfDays.

Returns:
Integer

setNumberOfDays

public void setNumberOfDays(java.lang.Integer numberOfDays)
Sets the GetItemTransactionsRequestType.numberOfDays.

Parameters:
numberOfDays - Integer

getOrderLineItemID

public java.lang.String getOrderLineItemID()
Gets the GetItemTransactionsRequestType.orderLineItemID.

Returns:
String

setOrderLineItemID

public void setOrderLineItemID(java.lang.String orderLineItemID)
Sets the GetItemTransactionsRequestType.orderLineItemID.

Parameters:
orderLineItemID - String

getPagination

public PaginationType getPagination()
Gets the GetItemTransactionsRequestType.pagination.

Returns:
PaginationType

setPagination

public void setPagination(PaginationType pagination)
Sets the GetItemTransactionsRequestType.pagination.

Parameters:
pagination - PaginationType

getPlatform

public TransactionPlatformCodeType getPlatform()
Gets the GetItemTransactionsRequestType.platform.

Returns:
TransactionPlatformCodeType

setPlatform

public void setPlatform(TransactionPlatformCodeType platform)
Sets the GetItemTransactionsRequestType.platform.

Parameters:
platform - TransactionPlatformCodeType

getTransactionID

public java.lang.String getTransactionID()
Gets the GetItemTransactionsRequestType.transactionID.

Returns:
String

setTransactionID

public void setTransactionID(java.lang.String transactionID)
Sets the GetItemTransactionsRequestType.transactionID.

Parameters:
transactionID - String

getEntireItemTransactions

public TransactionType[] getEntireItemTransactions()
                                            throws ApiException,
                                                   SdkException,
                                                   java.lang.Exception
Get all item transactions in specified date range. It handles pagination internally and ignores the Pagination property. GetItemTransactionsCall.ItemID and GetItemTransactionsCall.ModifiedTimeFilter will be ignored.

Parameters:
modifiedTimeFilter - TimeFilter
Returns:
TransactionType[]
Throws:
ApiException
SdkException
java.lang.Exception

getItemTransactions

public TransactionType[] getItemTransactions(java.lang.String itemID,
                                             TimeFilter modifiedTimeFilter)
                                      throws ApiException,
                                             SdkException,
                                             java.lang.Exception
Execute the API call. GetItemTransactionsCall.ItemID and GetItemTransactionsCall.ModifiedTimeFilter will be ignored.

Parameters:
itemID - String Unique ID of item that you are retrieving transactions for.
modifiedTimeFilter - TimeFilter Range of transactions that you are retrieving.
Returns:
TransactionType[]
Throws:
ApiException
SdkException
java.lang.Exception

setIncludeFinalValueFe

public void setIncludeFinalValueFe(java.lang.Boolean includeFinalValueFee)
Backward compatible function - do not use


getHasMoreTransactions

public boolean getHasMoreTransactions()
Valid after executing the API. Gets the returned GetItemTransactionsResponseType.hasMoreTransactions.

Returns:
boolean

getItem

public ItemType getItem()
Valid after executing the API. Gets the returned GetItemTransactionsResponseType.item.

Returns:
ItemType

getPaginationResult

public PaginationResultType getPaginationResult()
Valid after executing the API. Gets the returned GetItemTransactionsResponseType.paginationResult.

Returns:
PaginationResultType

getPayPalPreferred

public boolean getPayPalPreferred()
Valid after executing the API. Gets the returned GetItemTransactionsResponseType.payPalPreferred.

Returns:
boolean

getReturnedPageNumber

public java.lang.Integer getReturnedPageNumber()
Valid after executing the API. Gets the returned GetItemTransactionsResponseType.returnedPageNumber.

Returns:
Integer

getReturnedTransactionCountActual

public int getReturnedTransactionCountActual()
Valid after executing the API. Gets the returned GetItemTransactionsResponseType.returnedTransactionCountActual.

Returns:
int

getReturnedTransactions

public TransactionType[] getReturnedTransactions()
Valid after executing the API. Gets the returned GetItemTransactionsResponseType.returnedTransactions.

Returns:
TransactionType[]

getReturnedTransactionsPerPage

public java.lang.Integer getReturnedTransactionsPerPage()
Valid after executing the API. Gets the returned GetItemTransactionsResponseType.returnedTransactionsPerPage.

Returns:
Integer

Changes since
the last release

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.