Changes since
the last release

com.ebay.sdk.call
Class GetSellerTransactionsCall

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

public class GetSellerTransactionsCall
extends ApiCall

Wrapper class of the GetSellerTransactions 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: ModifiedTimeFilter - Helper wrapper to set GetSellerTransactionsRequestType ModTimeFrom, ModTimeTo: TimeFrom sets GetSellerTransactionsRequestType.ModTimeFrom: The ModTimeFrom and ModTimeTo fields specify a date range for retrieving order line items associated with the seller. The ModTimeFrom field is the starting date range. All of the seller'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. This field is not applicable 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 GetSellerTransactionsRequestType.ModTimeTo: The ModTimeFrom and ModTimeTo fields specify a date range for retrieving order line items associated with the seller. The ModTimeTo field is the ending date range. All of the seller'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.

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 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: Pagination - Child elements control pagination of the output. Use EntriesPerPage property to control the number of transactions to return per call and PageNumber property to specify the page of data to return.
Input property: IncludeFinalValueFee - Indicates whether to include Final Value Fee (FVF) in the response. For most listing types, the Final Value Fee is returned in Transaction.FinalValueFee. The Final Value Fee is returned for each 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 (transactions) that are part of the same order.
Input property: SKUArray - Container for a set of SKUs. Filters (reduces) the response to only include order line items for listings that include any of the specified SKUs. If multiple listings include the same SKU, order line items for all of them are returned (assuming they also match the other criteria in the GetSellerTransactions request).

You can combine SKUArray with InventoryTrackingMethod. For example, if you also pass in InventoryTrackingMethod=SKU, the response only includes order line items for listings that include InventoryTrackingMethod=SKU and one of the requested SKUs.
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 GetSellerTransactions 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 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 - Enables you to specify the number of days' worth of new and modified order line items that you want to retrieve. The maximum value for this field is 30

The call response contains the order line items whose status was modified within the specified number of days since the API call was made. NumberOfDays is often preferable to using the ModTimeFrom and ModTimeTo filters because you only need to specify one value. If you use NumberOfDays, then ModTimeFrom and ModTimeTo are ignored.

For this field, one day is defined as 24 hours.
Input property: InventoryTrackingMethod - Filters the response to only include order line items for listings that match this InventoryTrackingMethod setting.

For example,
Note: To specify the InventoryTrackingMethod when you create a listing, use AddFixedPriceItem or RelistFixedPriceItem. AddFixedPriceItem and RelistFixedPriceItem are defined in the Merchant Data API (part of Large Merchant Services).
You can combine SKUArray with InventoryTrackingMethod. For example, if you set this to SKU and you also pass in SKUArray, the response only includes order line items for listings that include InventoryTrackingMethod = SKU and one of the requested SKUs.
Input property: IncludeCodiceFiscale - If this field is included in the call request and set to true, taxpayer identification information for the buyer is returned under the BuyerTaxIdentifier

Codice Fiscale is only applicable to buyers on the Italy and Spain sites. It is required that buyers on the Italy site provide their Codice Fiscale ID before buying an item, and sellers on the Spain site have the option of requiring buyers on the Spain site to provide their taxpayer ID.
Output property: PaginationResult - Container consisting of the total number of order line items that match the input criteria and the total number of pages that must be scrolled through to view all order line items. To scroll through each page of order line item data, make subsequent GetSellerTransactions calls, incrementing the Pagination.PageNumber field by a value of '1' each time.
Output property: HasMoreTransactions - This flag indicates whether there are additional pages of order line items to view. This field will be returned as true if there are additional pages or order line items to view, or false if the current page of order line item data is the last page of data.
Output property: ReturnedTransactionsPerPage - This value indicates the number of order line items returned per page (per call) and is controlled by the Pagination.EntriesPerPage value passed in the call request. Unless it is the last (or possibly only) page of data (HasMoreTransactions=false), the TransactionsPerPage value should equal the Pagination.EntriesPerPage value passed in the call request.

Note: Due to the fact that item data on the eBay platform has a shorter retention period than order data, it is possible that some retrieved pages will contain no data. For pages that contain no data, the ReturnedTransactionCountActual value will be '0'. It is also possible that pages 2, 3, and 4 have no data, but pages 1 and 5 do have data. Therefore, we recommend that you scroll through each page of data (making subsequent GetSellerTransactions calls and incrementing the Pagination.PageNumber value by '1' each time) until you reach the last page, indicated by HasMoreTransactions=false.
Output property: ReturnedPageNumber - This value indicates the page number of retrieved order line items that match the input criteria. This value is controlled by the Pagination.PageNumber value passed in the call request. To scroll through all pages of order line items that match the input criteria, you increment the Pagination.PageNumber value by 1 with each subsequent GetSellerTransactions call.
Output property: ReturnedTransactionCountActual - This value indicates the total number of (non-empty) order line items retrieved in the current page of results. The ReturnedTransactionCountActual value will be lower than the TransactionsPerPage value if one or more empty order line items are retrieved on the page.

Note: Due to the fact that item data on the eBay platform has a shorter retention period than order data, it is possible that some retrieved pages will contain no data. For pages that contain no order line item data, the ReturnedTransactionCountActual value will be '0'. It is also possible that pages 2, 3, and 4 have no data, but pages 1 and 5 do have data. Therefore, we recommend that you scroll through each page of data (making subsequent GetSellerTransactions calls and incrementing the Pagination.PageNumber value by '1' each time) until you reach the last page, indicated by HasMoreTransactions=false.
Output property: Seller - Contains information about the seller whose order line items are being returned. See the reference guide for information about the Seller object fields that are returned.
Output property: ReturnedTransactions - List of Transaction objects representing the seller's recent sales. Each Transaction object contains the data for one purchase (of one or more items in the same listing). See the reference guide for more information about the fields that are returned for each order line item.
Output property: PayPalPreferred - Indicates whether the 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
GetSellerTransactionsCall()
          Constructor.
GetSellerTransactionsCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 TransactionType[] getEntireSellerTransactions()
          Get all seller transactions in specified date range.
 TransactionType[] getEntireSellerTransactions(TimeFilter modifiedTimeFilter)
          Get all seller transactions in specified date range.
 boolean getHasMoreTransactions()
          Valid after executing the API.
 Boolean getIncludeCodiceFiscale()
          Gets the GetSellerTransactionsRequestType.includeCodiceFiscale.
 Boolean getIncludeContainingOrder()
          Gets the GetSellerTransactionsRequestType.includeContainingOrder.
 Boolean getIncludeFinalValueFee()
          Gets the GetSellerTransactionsRequestType.includeFinalValueFee.
 InventoryTrackingMethodCodeType getInventoryTrackingMethod()
          Gets the GetSellerTransactionsRequestType.inventoryTrackingMethod.
 TimeFilter getModifiedTimeFilter()
          Gets the GetSellerTransactionsRequestType.modifiedTimeFilter.
 Integer getNumberOfDays()
          Gets the GetSellerTransactionsRequestType.numberOfDays.
 PaginationType getPagination()
          Gets the GetSellerTransactionsRequestType.pagination.
 PaginationResultType getPaginationResult()
          Valid after executing the API.
 boolean getPayPalPreferred()
          Valid after executing the API.
 TransactionPlatformCodeType getPlatform()
          Gets the GetSellerTransactionsRequestType.platform.
 Integer getReturnedPageNumber()
          Valid after executing the API.
 int getReturnedTransactionCountActual()
          Valid after executing the API.
 TransactionType[] getReturnedTransactions()
          Valid after executing the API.
 Integer getReturnedTransactionsPerPage()
          Valid after executing the API.
 UserType getSeller()
          Valid after executing the API.
 TransactionType[] getSellerTransactions()
          Retrieves transaction information for the user for which the call is made (and not for any other user), where a transaction is the information about the sale of one or more items by one buyer from a single listing.
 TransactionType[] getSellerTransactions(TimeFilter modifiedTimeFilter)
          Executes the API.
 SKUArrayType getSKUArray()
          Gets the GetSellerTransactionsRequestType.sKUArray.
 TimeFilter getTimeFilter()
           
 void setIncludeCodiceFiscale(Boolean includeCodiceFiscale)
          Sets the GetSellerTransactionsRequestType.includeCodiceFiscale.
 void setIncludeContainingOrder(Boolean includeContainingOrder)
          Sets the GetSellerTransactionsRequestType.includeContainingOrder.
 void setIncludeFinalValueFee(Boolean includeFinalValueFee)
          Sets the GetSellerTransactionsRequestType.includeFinalValueFee.
 void setInventoryTrackingMethod(InventoryTrackingMethodCodeType inventoryTrackingMethod)
          Sets the GetSellerTransactionsRequestType.inventoryTrackingMethod.
 void setModifiedTimeFilter(TimeFilter modifiedTimeFilter)
          Sets the GetSellerTransactionsRequestType.modifiedTimeFilter.
 void setNumberOfDays(Integer numberOfDays)
          Sets the GetSellerTransactionsRequestType.numberOfDays.
 void setPagination(PaginationType pagination)
          Sets the GetSellerTransactionsRequestType.pagination.
 void setPlatform(TransactionPlatformCodeType platform)
          Sets the GetSellerTransactionsRequestType.platform.
 void setSKUArray(SKUArrayType sKUArray)
          Sets the GetSellerTransactionsRequestType.sKUArray.
 void setTimeFilter(TimeFilter timeFilter)
          Sets time filter for transactions to be returned.
 
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, removeSendRequestListener, setApiContext, setBotBlock, setCallRetry, setDetailLevel, setEnableCompression, 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

GetSellerTransactionsCall

public GetSellerTransactionsCall()
Constructor.


GetSellerTransactionsCall

public GetSellerTransactionsCall(ApiContext apiContext)
Constructor.

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

getSellerTransactions

public TransactionType[] getSellerTransactions()
                                        throws ApiException,
                                               SdkException,
                                               Exception
Retrieves transaction information for the user for which the call is made (and not for any other user), where a transaction is the information about the sale of one or more items by one buyer from a single listing. (To retrieve transactions for another seller's listing, use GetItemTransactions.)

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

getIncludeCodiceFiscale

public Boolean getIncludeCodiceFiscale()
Gets the GetSellerTransactionsRequestType.includeCodiceFiscale.

Returns:
Boolean

setIncludeCodiceFiscale

public void setIncludeCodiceFiscale(Boolean includeCodiceFiscale)
Sets the GetSellerTransactionsRequestType.includeCodiceFiscale.

Parameters:
includeCodiceFiscale - Boolean

getIncludeContainingOrder

public Boolean getIncludeContainingOrder()
Gets the GetSellerTransactionsRequestType.includeContainingOrder.

Returns:
Boolean

setIncludeContainingOrder

public void setIncludeContainingOrder(Boolean includeContainingOrder)
Sets the GetSellerTransactionsRequestType.includeContainingOrder.

Parameters:
includeContainingOrder - Boolean

getIncludeFinalValueFee

public Boolean getIncludeFinalValueFee()
Gets the GetSellerTransactionsRequestType.includeFinalValueFee.

Returns:
Boolean

setIncludeFinalValueFee

public void setIncludeFinalValueFee(Boolean includeFinalValueFee)
Sets the GetSellerTransactionsRequestType.includeFinalValueFee.

Parameters:
includeFinalValueFee - Boolean

getInventoryTrackingMethod

public InventoryTrackingMethodCodeType getInventoryTrackingMethod()
Gets the GetSellerTransactionsRequestType.inventoryTrackingMethod.

Returns:
InventoryTrackingMethodCodeType

setInventoryTrackingMethod

public void setInventoryTrackingMethod(InventoryTrackingMethodCodeType inventoryTrackingMethod)
Sets the GetSellerTransactionsRequestType.inventoryTrackingMethod.

Parameters:
inventoryTrackingMethod - InventoryTrackingMethodCodeType

getModifiedTimeFilter

public TimeFilter getModifiedTimeFilter()
Gets the GetSellerTransactionsRequestType.modifiedTimeFilter.

Returns:
TimeFilter

setModifiedTimeFilter

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

Parameters:
modifiedTimeFilter - TimeFilter

getNumberOfDays

public Integer getNumberOfDays()
Gets the GetSellerTransactionsRequestType.numberOfDays.

Returns:
Integer

setNumberOfDays

public void setNumberOfDays(Integer numberOfDays)
Sets the GetSellerTransactionsRequestType.numberOfDays.

Parameters:
numberOfDays - Integer

getPagination

public PaginationType getPagination()
Gets the GetSellerTransactionsRequestType.pagination.

Returns:
PaginationType

setPagination

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

Parameters:
pagination - PaginationType

getPlatform

public TransactionPlatformCodeType getPlatform()
Gets the GetSellerTransactionsRequestType.platform.

Returns:
TransactionPlatformCodeType

setPlatform

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

Parameters:
platform - TransactionPlatformCodeType

getSKUArray

public SKUArrayType getSKUArray()
Gets the GetSellerTransactionsRequestType.sKUArray.

Returns:
SKUArrayType

setSKUArray

public void setSKUArray(SKUArrayType sKUArray)
Sets the GetSellerTransactionsRequestType.sKUArray.

Parameters:
sKUArray - SKUArrayType

getEntireSellerTransactions

public TransactionType[] getEntireSellerTransactions()
                                              throws ApiException,
                                                     SdkException,
                                                     Exception
Get all seller transactions in specified date range. It handles pagination internally and ignores the Pagination property. GetSellerTransactionsCall.TimeFilter will be ignored.

Returns:
TransactionType[]
Throws:
ApiException
SdkException
Exception

getEntireSellerTransactions

public TransactionType[] getEntireSellerTransactions(TimeFilter modifiedTimeFilter)
                                              throws ApiException,
                                                     SdkException,
                                                     Exception
Get all seller transactions in specified date range. It handles pagination internally and ignores the Pagination property.

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

getSellerTransactions

public TransactionType[] getSellerTransactions(TimeFilter modifiedTimeFilter)
                                        throws ApiException,
                                               SdkException,
                                               Exception
Executes the API. GetSellerTransactionsCall.TimeFilter will be ignored.

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

getTimeFilter

public TimeFilter getTimeFilter()
Returns:
TimeFilter

setTimeFilter

public void setTimeFilter(TimeFilter timeFilter)
Sets time filter for transactions to be returned.

Parameters:
timeFilter - TimeFilter

getHasMoreTransactions

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

Returns:
boolean

getPaginationResult

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

Returns:
PaginationResultType

getPayPalPreferred

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

Returns:
boolean

getReturnedPageNumber

public Integer getReturnedPageNumber()
Valid after executing the API. Gets the returned GetSellerTransactionsResponseType.returnedPageNumber.

Returns:
Integer

getReturnedTransactionCountActual

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

Returns:
int

getReturnedTransactions

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

Returns:
TransactionType[]

getReturnedTransactionsPerPage

public Integer getReturnedTransactionsPerPage()
Valid after executing the API. Gets the returned GetSellerTransactionsResponseType.returnedTransactionsPerPage.

Returns:
Integer

getSeller

public UserType getSeller()
Valid after executing the API. Gets the returned GetSellerTransactionsResponseType.seller.

Returns:
UserType

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.