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 are used to 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 created (or 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. 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 are used to 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 created (or 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 - If many order line items are available to retrieve, you may need to call GetSellerTransactions multiple times to retrieve all the data. Each result set is returned as a page of order line items. Use the Pagination filters to control the maximum number of order line items to retrieve per page (i.e., per call), and the page number to retrieve.
Input property: IncludeFinalValueFee - 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.

Input property: IncludeContainingOrder - This field is included and set to true if the user wants to view order-level details, including the unique identifier of the order and the status of the order. The order-level details will be shown in the ContainingOrder container in the response.

Input property: SKUArray - This container is used to search for order line items generated from one or more product SKU values. The response will only include order line items for the seller's product(s) that are represented by the specified SKU value(s).

If a user wants to retrieve order line items based on SKUs, the InventoryTrackingMethod must be set to SKU. The InventoryTrackingMethod value can be set when the seller lists the item through an AddFixedPriceItem call, or it can be set by including the InventoryTrackingMethod field in a GetSellerTransactions call and setting its value to SKU.

Note: SKU values must be defined for products in listings for this container to be applicable.
Input property: Platform - 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.
Input property: NumberOfDays - This field is used to specify how many days (24-hour periods) back in the past you wish to retrieve order line items. All order line items created (or last modified) within this period are retrieved. This value can be set between 1 (day) and 30 (days), and defaults to 30 (days) if omitted from the call.

If the NumberOfDays filter is used, ModTimeFrom and ModTimeTo date range filters are ignored (if included in the same request).

Input property: InventoryTrackingMethod - This filter is used if the seller wishes to set/change the inventory tracking method. When creating a listing with the AddFixedPriceItem call (or relisting with RelistFixedPriceItem call), sellers can decide whether to track their inventory by Item ID (generated by eBay at listing time) or by seller-defined SKU value.

This field is needed (and its value must be set to SKU) if the seller wishes to retrieve order line items based on specified SKU values (specified through SKUArray container) and the current inventory tracking method is set to Item ID.

A seller can use a GetItem call for a listing (and look for the Item.InventoryTrackingMethod in the response) to see which inventory tracking method is used for the listing/product.
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 container.

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.
 java.lang.Boolean getIncludeCodiceFiscale()
          Gets the GetSellerTransactionsRequestType.includeCodiceFiscale.
 java.lang.Boolean getIncludeContainingOrder()
          Gets the GetSellerTransactionsRequestType.includeContainingOrder.
 java.lang.Boolean getIncludeFinalValueFee()
          Gets the GetSellerTransactionsRequestType.includeFinalValueFee.
 InventoryTrackingMethodCodeType getInventoryTrackingMethod()
          Gets the GetSellerTransactionsRequestType.inventoryTrackingMethod.
 TimeFilter getModifiedTimeFilter()
          Gets the GetSellerTransactionsRequestType.modifiedTimeFilter.
 java.lang.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.
 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.
 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(java.lang.Boolean includeCodiceFiscale)
          Sets the GetSellerTransactionsRequestType.includeCodiceFiscale.
 void setIncludeContainingOrder(java.lang.Boolean includeContainingOrder)
          Sets the GetSellerTransactionsRequestType.includeContainingOrder.
 void setIncludeFinalValueFee(java.lang.Boolean includeFinalValueFee)
          Sets the GetSellerTransactionsRequestType.includeFinalValueFee.
 void setInventoryTrackingMethod(InventoryTrackingMethodCodeType inventoryTrackingMethod)
          Sets the GetSellerTransactionsRequestType.inventoryTrackingMethod.
 void setModifiedTimeFilter(TimeFilter modifiedTimeFilter)
          Sets the GetSellerTransactionsRequestType.modifiedTimeFilter.
 void setNumberOfDays(java.lang.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, 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

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,
                                               java.lang.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
java.lang.Exception

getIncludeCodiceFiscale

public java.lang.Boolean getIncludeCodiceFiscale()
Gets the GetSellerTransactionsRequestType.includeCodiceFiscale.

Returns:
Boolean

setIncludeCodiceFiscale

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

Parameters:
includeCodiceFiscale - Boolean

getIncludeContainingOrder

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

Returns:
Boolean

setIncludeContainingOrder

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

Parameters:
includeContainingOrder - Boolean

getIncludeFinalValueFee

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

Returns:
Boolean

setIncludeFinalValueFee

public void setIncludeFinalValueFee(java.lang.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 java.lang.Integer getNumberOfDays()
Gets the GetSellerTransactionsRequestType.numberOfDays.

Returns:
Integer

setNumberOfDays

public void setNumberOfDays(java.lang.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,
                                                     java.lang.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
java.lang.Exception

getEntireSellerTransactions

public TransactionType[] getEntireSellerTransactions(TimeFilter modifiedTimeFilter)
                                              throws ApiException,
                                                     SdkException,
                                                     java.lang.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
java.lang.Exception

getSellerTransactions

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

Parameters:
modifiedTimeFilter - TimeFilter
Returns:
TransactionType[]
Throws:
ApiException
SdkException
java.lang.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 java.lang.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 java.lang.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.