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 - Specifies the order in which returned items are sorted (based on the end dates of the item listings). Valid values:
0 = No sorting
1 = Sort in descending order
2 = Sort in ascending order

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 - Contains the data controlling the pagination of the returned values. If you set a DetailLevel in this call, you must set pagination values. The Pagination field contains the number of items to be returned per page of data (per call), and the page number to return with the current call.
Input property: GranularityLevel - Specifies the subset of item and user fields to return. See GetSellerList for a list of the fields that are returned for each granularity level. For GetSellerList, use DetailLevel or GranularityLevel in a request, but not both. For GetSellerList, if GranularityLevel is specified, DetailLevel is ignored.
Input property: SKUArray - Container for a set of SKUs. Filters (reduces) the response to only include active listings that the seller listed with any of the specified SKUs. If multiple listings include the same SKU, they are all returned (assuming they also match the other criteria in the GetSellerList request).

SKUArray can be used to retrieve items listed by the user identified in AuthToken or in UserID.

Note: Listings with matching SKUs are returned regardless of their Item.InventoryTrackingMethod settings.
Input property: IncludeWatchCount - Specifies whether to include WatchCount in Item nodes returned. WatchCount is only returned with DetailLevel ReturnAll.
Input property: AdminEndedItemsOnly - Specifies whether to return only items that were administratively ended based on a policy violation.
Input property: CategoryID - The category ID for the items retrieved. If you specify CategoryID in a GetSellerList call, the response contains only items in the category you specify.
Input property: IncludeVariations - If true, the Variations node is returned for all multi-variation listings in the response.

Note: If the seller includes a large number of variations in many listings, using this flag may degrade the call's performance. Therefore, when you use this flag, you may need to reduce the total number of items you're requesting at once.

For example, you may need to use shorter time ranges in the EndTime or StartTime filters, fewer entries per page in Pagination, and/or SKUArray.
Output property: PaginationResult - Contains information regarding the pagination of data (if pagination is used), including total number of pages and total number of entries.
Output property: HasMoreItems - If true, there are more items yet to be retrieved. Additional GetSellerList calls with higher page numbers or more items per page must be made to retrieve these items. Not returned if no items match the request.
Output property: ReturnedItems - Contains the list of the seller's items, one ItemType object per item. Returns empty if no items are available that match the request.
Output property: ReturnedItemsPerPage - Indicates the number of items that are being returned per page of data (i.e., per call). Will be the same as the value specified in the Pagination.EntriesPerPage input. Only returned if items are returned.
Output property: ReturnedPageNumber - Indicates which page of data was just returned. Will be the same as the value specified in the Pagination.PageNumber input. (If the input is higher than the total number of pages, the call fails with an error.) Only returned if items are returned.
Output property: ReturnedItemCountActual - Indicates the total number of items returned (i.e., the number of ItemType objects in ItemArray).
Output property: Seller - Indicates the seller whose items are returned. The seller is the eBay member whose UserID was passed in the request. If UserID was not specified, the seller is the user who made the request (identified by eBayAuthToken).

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()
          Retrieves a list of the items posted by the authenticated user, including the related item data.
 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
Retrieves a list of the items posted by the authenticated user, including the related item data.

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.