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 - Include this container and set the ScheduledList.Include field to true to return the list of items that are scheduled to become active listings on eBay.com at a future date/time.

The user also has the option of using pagination and sorting for the list of Scheduled listings that will be returned.
Input property: ActiveList - Include this container and set the ActiveList.Include field to true to return the list of active listings on eBay.com.

The user also has the option of using pagination and sorting for the list of active listings that will be returned.
Input property: SoldList - Include this container and set the SoldList.Include field to true to return the list of sold order line items.

The user also has the option of using pagination and sorting for the list of sold items that will be returned.
Input property: UnsoldList - Include this container and set the UnsoldList.Include field to true to return the listings that have ended without a purchase.

The user also has the option of using pagination and sorting for the list of unsold items that will be returned.
Input property: BidList - This container is deprecated as a Bid List is no longer returned in GetMyeBaySelling.
Input property: DeletedFromSoldList - Include this container and set the DeletedFromSoldList.Include field to true to return the list of sold order line items that have since been deleted from the seller's My eBay page.

The user also has the option of using pagination and sorting for the list of deleted, sold items that will be returned.
Input property: DeletedFromUnsoldList - Include this container and set the DeletedFromUnsoldList.Include field to true to return the list of unsold order line items that have since been deleted from the seller's My eBay page.

The user also has the option of using pagination and sorting for the list of deleted, unsold items that will be returned.
Input property: SellingSummary - Include this container and set the SellingSummary.Include field to true to return the SellingSummary container in the response. The SellingSummary container consists of selling activity counts and values.
Input property: HideVariations - If this field is included and set to true, the Variations node (and all variation data) is omitted for all multiple-variation listings in the response. If this field is omitted or set to false, the Variations node is returned for all multiple-variation listings in the response.

Output property: ReturnedSellingSummary - This container consists of seller activity counts and values. For this container to be returned, the user must include the SellingSummary.Include field in the request and set its value to true.
Output property: ReturnedScheduledList - This container consists of the items that are scheduled to become active at a future date/time. This container will be returned if the eBay user has one or more listings scheduled to become active at a future date/time.

This container will not be returned in the response (even if there are listings scheduled to become active) if the DetailLevel value is set to ReturnSummary and the ScheduledList.Include field is omitted or set to false.
Output property: ReturnedActiveList - This container consists of active listings. This container will be returned if the eBay user has one or more active listings on eBay.com.

This container will not be returned in the response (even if there are one or more active listings) if the DetailLevel value is set to ReturnSummary and the ActiveList.Include field is omitted or set to false.
Output property: ReturnedSoldList - This container consists of order line items that have been sold. This container will be returned if the eBay user has one or more listings that have had recent sales.

This container will not be returned in the response (even if there are one or more sales) if the DetailLevel value is set to ReturnSummary and the SoldList.Include field is omitted or set to false.
Output property: ReturnedUnsoldList - This container consists of listings that have ended without sales. This container will be returned if the eBay user has one or more listings that have ended without sales.

This container will not be returned in the response (even if there are one or more listings that ended without sales) if the DetailLevel value is set to ReturnSummary and the UnsoldList.Include field is omitted or set to false.
Output property: ReturnedSummary - This container consists of seller activity counts and values. This container is always returned if there has been recent sell activity.
Output property: ReturnedBidList - This container is no longer applicable to GetMyeBaySelling.
Output property: ReturnedDeletedFromSoldList - This container consists of listings that have had sales but have been deleted from My eBay. This container will be returned if the eBay user has one or more listings with sales that have been deleted from My eBay.

This container will not be returned in the response (even if there are one or more listings that have sales but have been deleted) if the DetailLevel value is set to ReturnSummary and the DeletedFromSoldList.Include field is omitted or set to false.
Output property: ReturnedDeletedFromUnsoldList - This container consists of listings that have ended without sales and have been deleted from My eBay. This container will be returned if the eBay user has one or more listings with sales that have been deleted from My eBay.

This container will not be returned in the response (even if there are one or more listings that have sales but have been deleted) if the DetailLevel value is set to ReturnSummary and the DeletedFromSoldList.Include field is omitted or set to false.

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.
 java.lang.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), auction listings 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(java.lang.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, 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

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,
                             java.lang.Exception
Retrieves information regarding the user's selling activity, such as items that the user is currently selling (the Active list), auction listings that have bids, sold items, and unsold items.

Throws:
ApiException
SdkException
java.lang.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 java.lang.Boolean getHideVariations()
Gets the GetMyeBaySellingRequestType.hideVariations.

Returns:
Boolean

setHideVariations

public void setHideVariations(java.lang.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.