|
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.GetSellingManagerSoldListingsCall
public class GetSellingManagerSoldListingsCall
Wrapper class of the GetSellingManagerSoldListings 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.
Search
- This container is used if the seller would like to search for Selling Manager Sele Records based on certain identifiers like Saler Record ID, Item ID, listing title, buyer user ID, etc. The seller will specify one of the supported search types in SellingManagerSearchTypeCodeType, and then provides the value for that search type.
StoreCategoryID
- This field is used if the seller would like to retrieve all Selling Manager Sale Records for products listed in a specific eBay Store Category.
Filter
- One or more Filter fields can be used to retrieve Selling Manager Sale Records for orders that are in a certain state. See SellingManagerSoldListingsPropertyTypeCodeType for the supported values.
Archived
- This field is included and set to true
if the seller would like to retrieve one or more archived orders between 90 and 120 days old.
Sort
- This field is used if the seller would like to sort Selling Manager Sale Record results based on a specific aspect such as purchase date, checkout status, total price, etc. See SellingManagerSoldListingsSortTypeCodeType to read more about the available sorting options.
SortOrder
- This field allows the seller to sort in ascending or descending order (based on the selected aspect in the Sort field).
Pagination
- This container is used if the seller would like to control how many Sale Records are returned per page and which page to view.
SaleDateRange
- This container allows the seller to retrieve orders that were purchased within a specified time range. A time range can be set up to 90 days in the past (or up to 120 days if the Archived field is included and set to true
.
ReturnedSaleRecord
- A SaleRecord container is returned for each order that matches the input criteria.
ReturnedPaginationResult
- Contains the total number of pages (TotalNumberOfPages) and the total number of products entries (TotalNumberOfEntries) that can be returned on repeated calls with the same format and report criteria.
Field Summary |
---|
Fields inherited from class com.ebay.sdk.ApiCall |
---|
apiException, sendReqListeners |
Constructor Summary | |
---|---|
GetSellingManagerSoldListingsCall()
Constructor. |
|
GetSellingManagerSoldListingsCall(ApiContext apiContext)
Constructor. |
Method Summary | |
---|---|
java.lang.Boolean |
getArchived()
Gets the GetSellingManagerSoldListingsRequestType.archived. |
SellingManagerSoldListingsPropertyTypeCodeType[] |
getFilter()
Gets the GetSellingManagerSoldListingsRequestType.filter. |
PaginationType |
getPagination()
Gets the GetSellingManagerSoldListingsRequestType.pagination. |
PaginationResultType |
getReturnedPaginationResult()
Valid after executing the API. |
SellingManagerSoldOrderType[] |
getReturnedSaleRecord()
Valid after executing the API. |
TimeRangeType |
getSaleDateRange()
Gets the GetSellingManagerSoldListingsRequestType.saleDateRange. |
SellingManagerSearchType |
getSearch()
Gets the GetSellingManagerSoldListingsRequestType.search. |
SellingManagerSoldOrderType[] |
getSellingManagerSoldListings()
Returns a Selling Manager user's sold listings. |
SellingManagerSoldListingsSortTypeCodeType |
getSort()
Gets the GetSellingManagerSoldListingsRequestType.sort. |
SortOrderCodeType |
getSortOrder()
Gets the GetSellingManagerSoldListingsRequestType.sortOrder. |
java.lang.Long |
getStoreCategoryID()
Gets the GetSellingManagerSoldListingsRequestType.storeCategoryID. |
void |
setArchived(java.lang.Boolean archived)
Sets the GetSellingManagerSoldListingsRequestType.archived. |
void |
setFilter(SellingManagerSoldListingsPropertyTypeCodeType[] filter)
Sets the GetSellingManagerSoldListingsRequestType.filter. |
void |
setPagination(PaginationType pagination)
Sets the GetSellingManagerSoldListingsRequestType.pagination. |
void |
setSaleDateRange(TimeRangeType saleDateRange)
Sets the GetSellingManagerSoldListingsRequestType.saleDateRange. |
void |
setSearch(SellingManagerSearchType search)
Sets the GetSellingManagerSoldListingsRequestType.search. |
void |
setSort(SellingManagerSoldListingsSortTypeCodeType sort)
Sets the GetSellingManagerSoldListingsRequestType.sort. |
void |
setSortOrder(SortOrderCodeType sortOrder)
Sets the GetSellingManagerSoldListingsRequestType.sortOrder. |
void |
setStoreCategoryID(java.lang.Long storeCategoryID)
Sets the GetSellingManagerSoldListingsRequestType.storeCategoryID. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public GetSellingManagerSoldListingsCall()
public GetSellingManagerSoldListingsCall(ApiContext apiContext)
apiContext
- The ApiContext object to be used to make the call.Method Detail |
---|
public SellingManagerSoldOrderType[] getSellingManagerSoldListings() throws ApiException, SdkException, java.lang.Exception
ApiException
SdkException
java.lang.Exception
public java.lang.Boolean getArchived()
public void setArchived(java.lang.Boolean archived)
archived
- Booleanpublic SellingManagerSoldListingsPropertyTypeCodeType[] getFilter()
public void setFilter(SellingManagerSoldListingsPropertyTypeCodeType[] filter)
filter
- SellingManagerSoldListingsPropertyTypeCodeType[]public PaginationType getPagination()
public void setPagination(PaginationType pagination)
pagination
- PaginationTypepublic TimeRangeType getSaleDateRange()
public void setSaleDateRange(TimeRangeType saleDateRange)
saleDateRange
- TimeRangeTypepublic SellingManagerSearchType getSearch()
public void setSearch(SellingManagerSearchType search)
search
- SellingManagerSearchTypepublic SellingManagerSoldListingsSortTypeCodeType getSort()
public void setSort(SellingManagerSoldListingsSortTypeCodeType sort)
sort
- SellingManagerSoldListingsSortTypeCodeTypepublic SortOrderCodeType getSortOrder()
public void setSortOrder(SortOrderCodeType sortOrder)
sortOrder
- SortOrderCodeTypepublic java.lang.Long getStoreCategoryID()
public void setStoreCategoryID(java.lang.Long storeCategoryID)
storeCategoryID
- Longpublic PaginationResultType getReturnedPaginationResult()
public SellingManagerSoldOrderType[] getReturnedSaleRecord()
|
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.