Changes since
the last release

com.ebay.sdk.call
Class GetSellingManagerSoldListingsCall

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

public class GetSellingManagerSoldListingsCall
extends ApiCall

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.


Input property: 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.
Input property: 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.
Input property: 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.
Input property: 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.
Input property: 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.
Input property: SortOrder - This field allows the seller to sort in ascending or descending order (based on the selected aspect in the Sort field).
Input property: 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.
Input property: 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.
Output property: ReturnedSaleRecord - A SaleRecord container is returned for each order that matches the input criteria.
Output property: 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.

Version:
1.0
Author:
Ron Murphy

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 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

GetSellingManagerSoldListingsCall

public GetSellingManagerSoldListingsCall()
Constructor.


GetSellingManagerSoldListingsCall

public GetSellingManagerSoldListingsCall(ApiContext apiContext)
Constructor.

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

getSellingManagerSoldListings

public SellingManagerSoldOrderType[] getSellingManagerSoldListings()
                                                            throws ApiException,
                                                                   SdkException,
                                                                   java.lang.Exception
Returns a Selling Manager user's sold listings.

This call is subject to change without notice; the deprecation process is inapplicable to this call. The user must have a Selling Manager Pro subscription to use this call.

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

getArchived

public java.lang.Boolean getArchived()
Gets the GetSellingManagerSoldListingsRequestType.archived.

Returns:
Boolean

setArchived

public void setArchived(java.lang.Boolean archived)
Sets the GetSellingManagerSoldListingsRequestType.archived.

Parameters:
archived - Boolean

getFilter

public SellingManagerSoldListingsPropertyTypeCodeType[] getFilter()
Gets the GetSellingManagerSoldListingsRequestType.filter.

Returns:
SellingManagerSoldListingsPropertyTypeCodeType[]

setFilter

public void setFilter(SellingManagerSoldListingsPropertyTypeCodeType[] filter)
Sets the GetSellingManagerSoldListingsRequestType.filter.

Parameters:
filter - SellingManagerSoldListingsPropertyTypeCodeType[]

getPagination

public PaginationType getPagination()
Gets the GetSellingManagerSoldListingsRequestType.pagination.

Returns:
PaginationType

setPagination

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

Parameters:
pagination - PaginationType

getSaleDateRange

public TimeRangeType getSaleDateRange()
Gets the GetSellingManagerSoldListingsRequestType.saleDateRange.

Returns:
TimeRangeType

setSaleDateRange

public void setSaleDateRange(TimeRangeType saleDateRange)
Sets the GetSellingManagerSoldListingsRequestType.saleDateRange.

Parameters:
saleDateRange - TimeRangeType

getSearch

public SellingManagerSearchType getSearch()
Gets the GetSellingManagerSoldListingsRequestType.search.

Returns:
SellingManagerSearchType

setSearch

public void setSearch(SellingManagerSearchType search)
Sets the GetSellingManagerSoldListingsRequestType.search.

Parameters:
search - SellingManagerSearchType

getSort

public SellingManagerSoldListingsSortTypeCodeType getSort()
Gets the GetSellingManagerSoldListingsRequestType.sort.

Returns:
SellingManagerSoldListingsSortTypeCodeType

setSort

public void setSort(SellingManagerSoldListingsSortTypeCodeType sort)
Sets the GetSellingManagerSoldListingsRequestType.sort.

Parameters:
sort - SellingManagerSoldListingsSortTypeCodeType

getSortOrder

public SortOrderCodeType getSortOrder()
Gets the GetSellingManagerSoldListingsRequestType.sortOrder.

Returns:
SortOrderCodeType

setSortOrder

public void setSortOrder(SortOrderCodeType sortOrder)
Sets the GetSellingManagerSoldListingsRequestType.sortOrder.

Parameters:
sortOrder - SortOrderCodeType

getStoreCategoryID

public java.lang.Long getStoreCategoryID()
Gets the GetSellingManagerSoldListingsRequestType.storeCategoryID.

Returns:
Long

setStoreCategoryID

public void setStoreCategoryID(java.lang.Long storeCategoryID)
Sets the GetSellingManagerSoldListingsRequestType.storeCategoryID.

Parameters:
storeCategoryID - Long

getReturnedPaginationResult

public PaginationResultType getReturnedPaginationResult()
Valid after executing the API. Gets the returned GetSellingManagerSoldListingsResponseType.returnedPaginationResult.

Returns:
PaginationResultType

getReturnedSaleRecord

public SellingManagerSoldOrderType[] getReturnedSaleRecord()
Valid after executing the API. Gets the returned GetSellingManagerSoldListingsResponseType.returnedSaleRecord.

Returns:
SellingManagerSoldOrderType[]

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.