|
Changes since the last release |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ebay.sdk.ApiCall
com.ebay.sdk.call.GetSellerListCall
public class GetSellerListCall
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.
UserID
- Specifies the seller whose items will be returned. UserID is an optional
input. If not specified, retrieves listings for the user identified by the
authentication token passed in the request. Note that since user
information is anonymous to everyone except the bidder and the seller
(during an active auction), only sellers looking for information about
their own listings and bidders who know the user IDs of their sellers will
be able to make this API call successfully.
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.
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.
Sort
- Specifies the order in which returned items are sorted (based on the end
dates of the item listings). Valid values:
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.
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.
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.
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).IncludeWatchCount
- Specifies whether to include WatchCount in Item nodes returned. WatchCount is only returned with DetailLevel ReturnAll.
AdminEndedItemsOnly
- Specifies whether to return only items that were administratively ended
based on a policy violation.
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.
IncludeVariations
- If true, the Variations node is returned for all multi-variation listings in the response.PaginationResult
- Contains information regarding the pagination of data (if pagination is
used), including total number of pages and total number of entries.
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.
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.
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.
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.
ReturnedItemCountActual
- Indicates the total number of items returned (i.e., the number of
ItemType objects in ItemArray).
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).
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 java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public GetSellerListCall()
public GetSellerListCall(ApiContext apiContext)
apiContext
- The ApiContext object to be used to make the call.Method Detail |
---|
public ItemType[] getSellerList() throws ApiException, SdkException, java.lang.Exception
ApiException
SdkException
java.lang.Exception
public GetSellerListRequestType getRequest()
public void setRequest(GetSellerListRequestType request)
request
- GetSellerListRequestTypepublic java.lang.Boolean getAdminEndedItemsOnly()
public void setAdminEndedItemsOnly(java.lang.Boolean adminEndedItemsOnly)
adminEndedItemsOnly
- Booleanpublic java.lang.Integer getCategoryID()
public void setCategoryID(java.lang.Integer categoryID)
categoryID
- Integerpublic TimeFilter getEndTimeFilter()
public void setEndTimeFilter(TimeFilter endTimeFilter)
endTimeFilter
- TimeFilterpublic GranularityLevelCodeType getGranularityLevel()
public void setGranularityLevel(GranularityLevelCodeType granularityLevel)
granularityLevel
- GranularityLevelCodeTypepublic java.lang.Boolean getIncludeVariations()
public void setIncludeVariations(java.lang.Boolean includeVariations)
includeVariations
- Booleanpublic java.lang.Boolean getIncludeWatchCount()
public void setIncludeWatchCount(java.lang.Boolean includeWatchCount)
includeWatchCount
- Booleanpublic UserIDArrayType getMotorsDealerUsers()
public void setMotorsDealerUsers(UserIDArrayType motorsDealerUsers)
motorsDealerUsers
- UserIDArrayTypepublic PaginationType getPagination()
public void setPagination(PaginationType pagination)
pagination
- PaginationTypepublic SKUArrayType getSKUArray()
public void setSKUArray(SKUArrayType sKUArray)
sKUArray
- SKUArrayTypepublic int getSort()
public void setSort(int sort)
sort
- intpublic TimeFilter getStartTimeFilter()
public void setStartTimeFilter(TimeFilter startTimeFilter)
startTimeFilter
- TimeFilterpublic java.lang.String getUserID()
public void setUserID(java.lang.String userID)
userID
- Stringpublic ItemType[] getEntireSellerList() throws ApiException, SdkException, java.lang.Exception
ApiException
SdkException
java.lang.Exception
public boolean getHasMoreItems()
public PaginationResultType getPaginationResult()
public int getReturnedItemCountActual()
public ItemType[] getReturnedItems()
public java.lang.Integer getReturnedItemsPerPage()
public java.lang.Integer getReturnedPageNumber()
public UserType getSeller()
|
Changes since the last release |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.