Changes since
the last release

com.ebay.sdk.call
Class GetMyeBaySellingCall

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

public class GetMyeBaySellingCall
extends ApiCall

Wrapper class of the GetMyeBaySelling 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: ScheduledList - Returns the list of items the user has scheduled to sell but whose listings have not yet opened.

Set Include to true to return the default response set.
Input property: ActiveList - Returns the list of items the user is actively selling (the currently active listings).

Set Include to true to return the default response set.
Input property: SoldList - Returns the list of items the user has sold.

Set Include to true to return the default response set.
Input property: UnsoldList - Returns the list of items the user has listed, but whose listings have ended without being sold.

Set Include to true to return the default response set.
Input property: BidList - Return the list of active items on which there are bids.

Set Include to true to return the default response set.
Input property: DeletedFromSoldList - Returns the list of items the user sold, and then deleted from their My eBay page. Allowed values for DurationInDays are 0-90.

Set Include to true to return the default response set.
Input property: DeletedFromUnsoldList - Returns the list of items the user either ended or did not sell, and subsequently were deleted them from their My eBay page. Allowed values for DurationInDays are 0-90.

Set Include to true to return the default response set.
Input property: SellingSummary - Returns a summary of the user's buying activity.

The SellingSummary is always returned by default. Add a SellingSummary element with an Include field set to false to exclude the SellingSummary from your response.
Input property: HideVariations - If true, the Variations node is omitted for all multi-variation listings in the response. If false, the Variations node is returned for all multi-variation listings in the response.

Please note that if the seller includes a large number of variations in many listings, retrieving variations (setting this flag to false) may degrade the call's performance. Therefore, when this is false, you may need to reduce the total number of items you're requesting at once (by using other input fields, such as Pagination).
Output property: ReturnedSellingSummary - Contains summary information about the items the user is selling.
Output property: ReturnedScheduledList - Contains the items the user has scheduled for sale, but whose listings have not yet started.
Output property: ReturnedActiveList - Contains the items the user is selling that have active listings.
Output property: ReturnedSoldList - Contains the items the user has sold.
Output property: ReturnedUnsoldList - Contains the items whose listings have ended but that have not sold.
Output property: ReturnedSummary - Contains summary information about the items the user is selling.
Output property: ReturnedBidList - This container is no longer applicable to GetMyeBaySelling.
Output property: ReturnedDeletedFromSoldList - Contains the items the seller has sold and deleted from My eBay.
Output property: ReturnedDeletedFromUnsoldList - Contains the items with listings that were ended or did not sell and have been deleted from My eBay.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
GetMyeBaySellingCall()
          Constructor.
GetMyeBaySellingCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 ItemListCustomizationType getActiveList()
          Gets the GetMyeBaySellingRequestType.activeList.
 ItemListCustomizationType getBidList()
          Gets the GetMyeBaySellingRequestType.bidList.
 ItemListCustomizationType getDeletedFromSoldList()
          Gets the GetMyeBaySellingRequestType.deletedFromSoldList.
 ItemListCustomizationType getDeletedFromUnsoldList()
          Gets the GetMyeBaySellingRequestType.deletedFromUnsoldList.
 Boolean getHideVariations()
          Gets the GetMyeBaySellingRequestType.hideVariations.
 void getMyeBaySelling()
          Retrieves information regarding the user's selling activity, such as items that the user is currently selling (the Active list), items that have bids, sold items, and unsold items.
 GetMyeBaySellingRequestType getMyeBaySellingRequest()
          Gets the GetMyeBaySellingRequestType.myeBaySellingRequest.
 PaginatedItemArrayType getReturnedActiveList()
          Valid after executing the API.
 PaginatedItemArrayType getReturnedBidList()
          Valid after executing the API.
 PaginatedOrderTransactionArrayType getReturnedDeletedFromSoldList()
          Valid after executing the API.
 PaginatedItemArrayType getReturnedDeletedFromUnsoldList()
          Valid after executing the API.
 GetMyeBaySellingResponseType getReturnedMyeBaySellingResponse()
          Valid after executing the API.
 PaginatedItemArrayType getReturnedScheduledList()
          Valid after executing the API.
 SellingSummaryType getReturnedSellingSummary()
          Valid after executing the API.
 PaginatedOrderTransactionArrayType getReturnedSoldList()
          Valid after executing the API.
 MyeBaySellingSummaryType getReturnedSummary()
          Valid after executing the API.
 PaginatedItemArrayType getReturnedUnsoldList()
          Valid after executing the API.
 ItemListCustomizationType getScheduledList()
          Gets the GetMyeBaySellingRequestType.scheduledList.
 ItemListCustomizationType getSellingSummary()
          Gets the GetMyeBaySellingRequestType.sellingSummary.
 ItemListCustomizationType getSoldList()
          Gets the GetMyeBaySellingRequestType.soldList.
 ItemListCustomizationType getUnsoldList()
          Gets the GetMyeBaySellingRequestType.unsoldList.
 void setActiveList(ItemListCustomizationType activeList)
          Sets the GetMyeBaySellingRequestType.activeList.
 void setBidList(ItemListCustomizationType bidList)
          Sets the GetMyeBaySellingRequestType.bidList.
 void setDeletedFromSoldList(ItemListCustomizationType deletedFromSoldList)
          Sets the GetMyeBaySellingRequestType.deletedFromSoldList.
 void setDeletedFromUnsoldList(ItemListCustomizationType deletedFromUnsoldList)
          Sets the GetMyeBaySellingRequestType.deletedFromUnsoldList.
 void setHideVariations(Boolean hideVariations)
          Sets the GetMyeBaySellingRequestType.hideVariations.
 void setMyeBaySellingRequest(GetMyeBaySellingRequestType myeBaySellingRequest)
          Sets the GetMyeBaySellingRequestType.myeBaySellingRequest.
 void setScheduledList(ItemListCustomizationType scheduledList)
          Sets the GetMyeBaySellingRequestType.scheduledList.
 void setSellingSummary(ItemListCustomizationType sellingSummary)
          Sets the GetMyeBaySellingRequestType.sellingSummary.
 void setSoldList(ItemListCustomizationType soldList)
          Sets the GetMyeBaySellingRequestType.soldList.
 void setUnsoldList(ItemListCustomizationType unsoldList)
          Sets the GetMyeBaySellingRequestType.unsoldList.
 
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, removeSendRequestListener, setApiContext, setBotBlock, setCallRetry, setDetailLevel, setEnableCompression, 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

GetMyeBaySellingCall

public GetMyeBaySellingCall()
Constructor.


GetMyeBaySellingCall

public GetMyeBaySellingCall(ApiContext apiContext)
Constructor.

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

getMyeBaySelling

public void getMyeBaySelling()
                      throws ApiException,
                             SdkException,
                             Exception
Retrieves information regarding the user's selling activity, such as items that the user is currently selling (the Active list), items that have bids, sold items, and unsold items.

Throws:
ApiException
SdkException
Exception

getMyeBaySellingRequest

public GetMyeBaySellingRequestType getMyeBaySellingRequest()
Gets the GetMyeBaySellingRequestType.myeBaySellingRequest.

Returns:
GetMyeBaySellingRequestType

setMyeBaySellingRequest

public void setMyeBaySellingRequest(GetMyeBaySellingRequestType myeBaySellingRequest)
Sets the GetMyeBaySellingRequestType.myeBaySellingRequest.

Parameters:
myeBaySellingRequest - GetMyeBaySellingRequestType

getActiveList

public ItemListCustomizationType getActiveList()
Gets the GetMyeBaySellingRequestType.activeList.

Returns:
ItemListCustomizationType

setActiveList

public void setActiveList(ItemListCustomizationType activeList)
Sets the GetMyeBaySellingRequestType.activeList.

Parameters:
activeList - ItemListCustomizationType

getBidList

public ItemListCustomizationType getBidList()
Gets the GetMyeBaySellingRequestType.bidList.

Returns:
ItemListCustomizationType

setBidList

public void setBidList(ItemListCustomizationType bidList)
Sets the GetMyeBaySellingRequestType.bidList.

Parameters:
bidList - ItemListCustomizationType

getDeletedFromSoldList

public ItemListCustomizationType getDeletedFromSoldList()
Gets the GetMyeBaySellingRequestType.deletedFromSoldList.

Returns:
ItemListCustomizationType

setDeletedFromSoldList

public void setDeletedFromSoldList(ItemListCustomizationType deletedFromSoldList)
Sets the GetMyeBaySellingRequestType.deletedFromSoldList.

Parameters:
deletedFromSoldList - ItemListCustomizationType

getDeletedFromUnsoldList

public ItemListCustomizationType getDeletedFromUnsoldList()
Gets the GetMyeBaySellingRequestType.deletedFromUnsoldList.

Returns:
ItemListCustomizationType

setDeletedFromUnsoldList

public void setDeletedFromUnsoldList(ItemListCustomizationType deletedFromUnsoldList)
Sets the GetMyeBaySellingRequestType.deletedFromUnsoldList.

Parameters:
deletedFromUnsoldList - ItemListCustomizationType

getHideVariations

public Boolean getHideVariations()
Gets the GetMyeBaySellingRequestType.hideVariations.

Returns:
Boolean

setHideVariations

public void setHideVariations(Boolean hideVariations)
Sets the GetMyeBaySellingRequestType.hideVariations.

Parameters:
hideVariations - Boolean

getScheduledList

public ItemListCustomizationType getScheduledList()
Gets the GetMyeBaySellingRequestType.scheduledList.

Returns:
ItemListCustomizationType

setScheduledList

public void setScheduledList(ItemListCustomizationType scheduledList)
Sets the GetMyeBaySellingRequestType.scheduledList.

Parameters:
scheduledList - ItemListCustomizationType

getSellingSummary

public ItemListCustomizationType getSellingSummary()
Gets the GetMyeBaySellingRequestType.sellingSummary.

Returns:
ItemListCustomizationType

setSellingSummary

public void setSellingSummary(ItemListCustomizationType sellingSummary)
Sets the GetMyeBaySellingRequestType.sellingSummary.

Parameters:
sellingSummary - ItemListCustomizationType

getSoldList

public ItemListCustomizationType getSoldList()
Gets the GetMyeBaySellingRequestType.soldList.

Returns:
ItemListCustomizationType

setSoldList

public void setSoldList(ItemListCustomizationType soldList)
Sets the GetMyeBaySellingRequestType.soldList.

Parameters:
soldList - ItemListCustomizationType

getUnsoldList

public ItemListCustomizationType getUnsoldList()
Gets the GetMyeBaySellingRequestType.unsoldList.

Returns:
ItemListCustomizationType

setUnsoldList

public void setUnsoldList(ItemListCustomizationType unsoldList)
Sets the GetMyeBaySellingRequestType.unsoldList.

Parameters:
unsoldList - ItemListCustomizationType

getReturnedMyeBaySellingResponse

public GetMyeBaySellingResponseType getReturnedMyeBaySellingResponse()
Valid after executing the API. Gets the returned GetMyeBaySellingResponseType.

Returns:
GetMyeBaySellingResponseType

getReturnedActiveList

public PaginatedItemArrayType getReturnedActiveList()
Valid after executing the API. Gets the returned GetMyeBaySellingResponseType.returnedActiveList.

Returns:
PaginatedItemArrayType

getReturnedBidList

public PaginatedItemArrayType getReturnedBidList()
Valid after executing the API. Gets the returned GetMyeBaySellingResponseType.returnedBidList.

Returns:
PaginatedItemArrayType

getReturnedDeletedFromSoldList

public PaginatedOrderTransactionArrayType getReturnedDeletedFromSoldList()
Valid after executing the API. Gets the returned GetMyeBaySellingResponseType.returnedDeletedFromSoldList.

Returns:
PaginatedOrderTransactionArrayType

getReturnedDeletedFromUnsoldList

public PaginatedItemArrayType getReturnedDeletedFromUnsoldList()
Valid after executing the API. Gets the returned GetMyeBaySellingResponseType.returnedDeletedFromUnsoldList.

Returns:
PaginatedItemArrayType

getReturnedScheduledList

public PaginatedItemArrayType getReturnedScheduledList()
Valid after executing the API. Gets the returned GetMyeBaySellingResponseType.returnedScheduledList.

Returns:
PaginatedItemArrayType

getReturnedSellingSummary

public SellingSummaryType getReturnedSellingSummary()
Valid after executing the API. Gets the returned GetMyeBaySellingResponseType.returnedSellingSummary.

Returns:
SellingSummaryType

getReturnedSoldList

public PaginatedOrderTransactionArrayType getReturnedSoldList()
Valid after executing the API. Gets the returned GetMyeBaySellingResponseType.returnedSoldList.

Returns:
PaginatedOrderTransactionArrayType

getReturnedSummary

public MyeBaySellingSummaryType getReturnedSummary()
Valid after executing the API. Gets the returned GetMyeBaySellingResponseType.returnedSummary.

Returns:
MyeBaySellingSummaryType

getReturnedUnsoldList

public PaginatedItemArrayType getReturnedUnsoldList()
Valid after executing the API. Gets the returned GetMyeBaySellingResponseType.returnedUnsoldList.

Returns:
PaginatedItemArrayType

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.