Changes since
the last release

com.ebay.sdk.call
Class GetSellerListCall

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

public class GetSellerListCall
extends ApiCall

Wrapper class of the GetSellerList 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: UserID - Note: This field should no longer be used, and will be ignored if it is included in a GetSellerList request. There are plans to remove this field from the public WSDL. The only eBay user ID that can be used is the one associated with the authentication token.
Input property: MotorsDealerUsers - Specifies the list of Motors Dealer sellers for which a special set of metrics can be requested. Applies to eBay Motors Pro applications only.
Input property: EndTimeFilter - Helper wrapper to set GetSellerListRequestType EndTimeFrom, EndTimeTo: TimeFrom sets GetSellerListRequestType.EndTimeFrom: Specifies the earliest (oldest) date to use in a date range filter based on item end time. Specify either an end-time range or a start-time range filter in every call request. Each of the time ranges must be a value less than 120 days. TimeTo sets GetSellerListRequestType.EndTimeTo: Specifies the latest (most recent) date to use in a date range filter based on item end time. Must be specified if EndTimeFrom is specified.
Input property: Sort - This field can be used to control the order in which returned listings are sorted (based on the listings' actual/scheduled end dates). Valid values are as follows:
Input property: StartTimeFilter - Helper wrapper to set GetSellerListRequestType StartTimeFrom, StartTimeTo: TimeFrom sets GetSellerListRequestType.StartTimeFrom: Specifies the earliest (oldest) date to use in a date range filter based on item start time. Each of the time ranges must be a value less than 120 days. In all calls, at least one date-range filter must be specified (i.e., you must specify either the end time range or start time range in every request). TimeTo sets GetSellerListRequestType.StartTimeTo: Specifies the latest (most recent) date to use in a date range filter based on item start time. Must be specified if StartTimeFrom is specified.
Input property: Pagination - This container controls the maximum number of listings that can appear on one page of the result set, as well as the page number of the result to return.

The GetSellerList call requires that the EntriesPerPage value be set. The PageNumber field is not required but will default to 1 if not included.
Input property: GranularityLevel - This field allows the user to control the amount of data that is returned in the response. See the Granularity Level table on this page for a list of the fields that are returned for each granularity level. Either GranularityLevel or DetailLevel can be used in a GetSellerList call, but not both. If both are specified, DetailLevel is ignored. If neither are used, the response fields will be the ones shown for 'Coarse' granularity.
Input property: SKUArray - This container can be used to specify one or multiple SKUs, and only listings associated with these SKUs are retrieved. Note that all other request criteria are also considered when one or more SKU values are specified.

Note: Listings with matching SKUs are returned regardless of their Item.InventoryTrackingMethod setting.
Input property: IncludeWatchCount - This field may be included and set to true if the seller wishes to see the number of eBay users that are watching each listing.
Input property: AdminEndedItemsOnly - This boolean field can be included and set to true if the seller would like to retrieve any listings that were administratively ended by eBay due to a listing policy violation.
Input property: CategoryID - If you specify a CategoryID value, the response will only contain listings in the category you specify.
Input property: IncludeVariations - If this field is included and set to true, the Variations node is returned for all multi-variation listings in the response.

Note: If the seller has many multiple-variation listings, that seller may not want to include variations in the GetSellerList response. Or, a seller can include variations data, but possibly limit the response by specifying shorter date ranges with the date range filters, or by reducing the number of listings returned per results (decreasing the Pagination.EntriesPerPage value).
Output property: PaginationResult - This container shows the total number or pages in the result set, as well as the total number of listings that match the current input criteria.
Output property: HasMoreItems - This field's value is returned as true if there are more pages in the current result set to view, or false if the current page being viewed is the last (or only) page of the result set.

If there are more listings to view in the result set, additional GetSellerList calls can be made but with changes to the Pagination values in the request. For example, if the Pagination.PageNumber value in the request for the last call was 1, you can make another GetSellerList call, keeping everything the same except changing the value of the Pagination.PageNumber field from 1 to 2.
Output property: ReturnedItems - This container is an array of one or more listings that match the input criteria. If none of the seller's listings match the input criteria, this container is returned as an empty tag.
Output property: ReturnedItemsPerPage - This value reflects the value that was set in the Pagination.EntriesPerPage field in the request. This is the maximum number of listings that may be returned per page of the result set. Note that this value is only the maximum threshold and does not necessarily reflect the number of listings appearing on the current page of data.
Output property: ReturnedPageNumber - This value indicates the current page of data in the result set that is being displayed. This value reflects the value specified in the Pagination.PageNumber field in the request. Note that page number defaults to 1 if the Pagination.PageNumber field was not included in the request.
Output property: ReturnedItemCountActual - This value indicates the total number of listings being shown on the current page of the results set.
Output property: Seller - This container consists of detailed information about the seller and the seller's account. This container is only returned if the GranularityLevel field is included in the request and set to Fine.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
GetSellerListCall()
          Constructor.
GetSellerListCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 java.lang.Boolean getAdminEndedItemsOnly()
          Gets the GetSellerListRequestType.adminEndedItemsOnly.
 java.lang.Integer getCategoryID()
          Gets the GetSellerListRequestType.categoryID.
 TimeFilter getEndTimeFilter()
          Gets the GetSellerListRequestType.endTimeFilter.
 ItemType[] getEntireSellerList()
          Get entire item list of the seller.
 GranularityLevelCodeType getGranularityLevel()
          Gets the GetSellerListRequestType.granularityLevel.
 boolean getHasMoreItems()
          Valid after executing the API.
 java.lang.Boolean getIncludeVariations()
          Gets the GetSellerListRequestType.includeVariations.
 java.lang.Boolean getIncludeWatchCount()
          Gets the GetSellerListRequestType.includeWatchCount.
 UserIDArrayType getMotorsDealerUsers()
          Gets the GetSellerListRequestType.motorsDealerUsers.
 PaginationType getPagination()
          Gets the GetSellerListRequestType.pagination.
 PaginationResultType getPaginationResult()
          Valid after executing the API.
 GetSellerListRequestType getRequest()
          Gets the GetSellerListRequestType.request.
 int getReturnedItemCountActual()
          Valid after executing the API.
 ItemType[] getReturnedItems()
          Valid after executing the API.
 java.lang.Integer getReturnedItemsPerPage()
          Valid after executing the API.
 java.lang.Integer getReturnedPageNumber()
          Valid after executing the API.
 UserType getSeller()
          Valid after executing the API.
 ItemType[] getSellerList()
          This call is used to retrieve an array of listings for the seller.
 SKUArrayType getSKUArray()
          Gets the GetSellerListRequestType.sKUArray.
 int getSort()
          Gets the GetSellerListRequestType.sort.
 TimeFilter getStartTimeFilter()
          Gets the GetSellerListRequestType.startTimeFilter.
 java.lang.String getUserID()
          Gets the GetSellerListRequestType.userID.
 void setAdminEndedItemsOnly(java.lang.Boolean adminEndedItemsOnly)
          Sets the GetSellerListRequestType.adminEndedItemsOnly.
 void setCategoryID(java.lang.Integer categoryID)
          Sets the GetSellerListRequestType.categoryID.
 void setEndTimeFilter(TimeFilter endTimeFilter)
          Sets the GetSellerListRequestType.endTimeFilter.
 void setGranularityLevel(GranularityLevelCodeType granularityLevel)
          Sets the GetSellerListRequestType.granularityLevel.
 void setIncludeVariations(java.lang.Boolean includeVariations)
          Sets the GetSellerListRequestType.includeVariations.
 void setIncludeWatchCount(java.lang.Boolean includeWatchCount)
          Sets the GetSellerListRequestType.includeWatchCount.
 void setMotorsDealerUsers(UserIDArrayType motorsDealerUsers)
          Sets the GetSellerListRequestType.motorsDealerUsers.
 void setPagination(PaginationType pagination)
          Sets the GetSellerListRequestType.pagination.
 void setRequest(GetSellerListRequestType request)
          Sets the GetSellerListRequestType.request.
 void setSKUArray(SKUArrayType sKUArray)
          Sets the GetSellerListRequestType.sKUArray.
 void setSort(int sort)
          Sets the GetSellerListRequestType.sort.
 void setStartTimeFilter(TimeFilter startTimeFilter)
          Sets the GetSellerListRequestType.startTimeFilter.
 void setUserID(java.lang.String userID)
          Sets the GetSellerListRequestType.userID.
 
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

GetSellerListCall

public GetSellerListCall()
Constructor.


GetSellerListCall

public GetSellerListCall(ApiContext apiContext)
Constructor.

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

getSellerList

public ItemType[] getSellerList()
                         throws ApiException,
                                SdkException,
                                java.lang.Exception
This call is used to retrieve an array of listings for the seller. The seller must be associated with the user/application token being used to make the call.

This call requires that either the 'Start Time' or 'End Time' date range filters be used. The date range specified by either of these filters can not exceed 120 days or an error will occur.

This call also requires that pagination be used.

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

getRequest

public GetSellerListRequestType getRequest()
Gets the GetSellerListRequestType.request.

Returns:
GetSellerListRequestType

setRequest

public void setRequest(GetSellerListRequestType request)
Sets the GetSellerListRequestType.request.

Parameters:
request - GetSellerListRequestType

getAdminEndedItemsOnly

public java.lang.Boolean getAdminEndedItemsOnly()
Gets the GetSellerListRequestType.adminEndedItemsOnly.

Returns:
Boolean

setAdminEndedItemsOnly

public void setAdminEndedItemsOnly(java.lang.Boolean adminEndedItemsOnly)
Sets the GetSellerListRequestType.adminEndedItemsOnly.

Parameters:
adminEndedItemsOnly - Boolean

getCategoryID

public java.lang.Integer getCategoryID()
Gets the GetSellerListRequestType.categoryID.

Returns:
Integer

setCategoryID

public void setCategoryID(java.lang.Integer categoryID)
Sets the GetSellerListRequestType.categoryID.

Parameters:
categoryID - Integer

getEndTimeFilter

public TimeFilter getEndTimeFilter()
Gets the GetSellerListRequestType.endTimeFilter.

Returns:
TimeFilter

setEndTimeFilter

public void setEndTimeFilter(TimeFilter endTimeFilter)
Sets the GetSellerListRequestType.endTimeFilter.

Parameters:
endTimeFilter - TimeFilter

getGranularityLevel

public GranularityLevelCodeType getGranularityLevel()
Gets the GetSellerListRequestType.granularityLevel.

Returns:
GranularityLevelCodeType

setGranularityLevel

public void setGranularityLevel(GranularityLevelCodeType granularityLevel)
Sets the GetSellerListRequestType.granularityLevel.

Parameters:
granularityLevel - GranularityLevelCodeType

getIncludeVariations

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

Returns:
Boolean

setIncludeVariations

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

Parameters:
includeVariations - Boolean

getIncludeWatchCount

public java.lang.Boolean getIncludeWatchCount()
Gets the GetSellerListRequestType.includeWatchCount.

Returns:
Boolean

setIncludeWatchCount

public void setIncludeWatchCount(java.lang.Boolean includeWatchCount)
Sets the GetSellerListRequestType.includeWatchCount.

Parameters:
includeWatchCount - Boolean

getMotorsDealerUsers

public UserIDArrayType getMotorsDealerUsers()
Gets the GetSellerListRequestType.motorsDealerUsers.

Returns:
UserIDArrayType

setMotorsDealerUsers

public void setMotorsDealerUsers(UserIDArrayType motorsDealerUsers)
Sets the GetSellerListRequestType.motorsDealerUsers.

Parameters:
motorsDealerUsers - UserIDArrayType

getPagination

public PaginationType getPagination()
Gets the GetSellerListRequestType.pagination.

Returns:
PaginationType

setPagination

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

Parameters:
pagination - PaginationType

getSKUArray

public SKUArrayType getSKUArray()
Gets the GetSellerListRequestType.sKUArray.

Returns:
SKUArrayType

setSKUArray

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

Parameters:
sKUArray - SKUArrayType

getSort

public int getSort()
Gets the GetSellerListRequestType.sort.

Returns:
int

setSort

public void setSort(int sort)
Sets the GetSellerListRequestType.sort.

Parameters:
sort - int

getStartTimeFilter

public TimeFilter getStartTimeFilter()
Gets the GetSellerListRequestType.startTimeFilter.

Returns:
TimeFilter

setStartTimeFilter

public void setStartTimeFilter(TimeFilter startTimeFilter)
Sets the GetSellerListRequestType.startTimeFilter.

Parameters:
startTimeFilter - TimeFilter

getUserID

public java.lang.String getUserID()
Gets the GetSellerListRequestType.userID.

Returns:
String

setUserID

public void setUserID(java.lang.String userID)
Sets the GetSellerListRequestType.userID.

Parameters:
userID - String

getEntireSellerList

public ItemType[] getEntireSellerList()
                               throws ApiException,
                                      SdkException,
                                      java.lang.Exception
Get entire item list of the seller. Properties EndDate and Pagination will be ignored. Patination related return fields (paginationResult, hasMoreItems) will be ignored.

Returns:
ItemType[]
Throws:
ApiException
SdkException
java.lang.Exception

getHasMoreItems

public boolean getHasMoreItems()
Valid after executing the API. Gets the returned GetSellerListResponseType.hasMoreItems.

Returns:
boolean

getPaginationResult

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

Returns:
PaginationResultType

getReturnedItemCountActual

public int getReturnedItemCountActual()
Valid after executing the API. Gets the returned GetSellerListResponseType.returnedItemCountActual.

Returns:
int

getReturnedItems

public ItemType[] getReturnedItems()
Valid after executing the API. Gets the returned GetSellerListResponseType.returnedItems.

Returns:
ItemType[]

getReturnedItemsPerPage

public java.lang.Integer getReturnedItemsPerPage()
Valid after executing the API. Gets the returned GetSellerListResponseType.returnedItemsPerPage.

Returns:
Integer

getReturnedPageNumber

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

Returns:
Integer

getSeller

public UserType getSeller()
Valid after executing the API. Gets the returned GetSellerListResponseType.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.