Changes since
the last release

com.ebay.sdk.call
Class GetMyeBayBuyingCall

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

public class GetMyeBayBuyingCall
extends ApiCall

Wrapper class of the GetMyeBayBuying 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: WatchList - Include this container and set the WatchList.Include field to true to return the list of items on the eBay user's Watch List.

The user also has the option of using pagination and sorting for the list of watched items that will be returned.
Input property: BidList - Include this container and set the BidList.Include field to true to return the list of auction items on which the eBay user has bid.

The user also has the option of using pagination and sorting for the list of auction items that will be returned.
Input property: BestOfferList - Include this container and set the BestOfferList.Include field to true to return the list of items on which the eBay user has made a Best Offer.

The user also has the option of using pagination and sorting for the list of items that will be returned.
Input property: WonList - Include this container and set the WonList.Include field to true to return the list of auction items on which the eBay user has bid on and won.

The user also has the option of using pagination and sorting for the list of auction items that will be returned.
Input property: LostList - Include this container and set the LostList.Include field to true to return the list of auction items on which the eBay user has bid on and lost.

The user also has the option of using pagination and sorting for the list of auction items that will be returned.
Input property: FavoriteSearches - Include this container and set the FavoriteSearches.Include field to true to return the list of the eBay user's saved searches.
Input property: FavoriteSellers - Include this container and set the FavoriteSellers.Include field to true to return the list of the eBay user's saved sellers.
Input property: SecondChanceOffer - Include this container and set the SecondChanceOffer.Include field to true to return any Second Chance Offers that the eBay user has received.
Input property: BidAssistantList - This field is deprecated.
Input property: DeletedFromWonList - Include this container and set the DeletedFromWonList.Include field to true to return the list of auction items on which the eBay user has bid on and won, but has deleted from their My eBay page.

The user also has the option of using pagination and sorting for the list of auction items that will be returned.
Input property: DeletedFromLostList - Include this container and set the DeletedFromLostList.Include field to true to return the list of auction items on which the eBay user has bid on and lost, and has deleted from their My eBay page.

The user also has the option of using pagination and sorting for the list of auction items that will be returned.
Input property: BuyingSummary - Include this container and set the BuyingSummary.Include field to true to return the BuyingSummary container in the response. The BuyingSummary container consists of buying/bidding activity counts and values.
Input property: UserDefinedLists - Include this container and set the UserDefinedLists.Include field to true to return one or more user-defined lists. User-defined lists are lists created by the user in My eBay and consists of a combination of items, saved sellers, and/or saved searches.
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: ReturnedBuyingSummary - This container consists of buying/bidding activity counts and values. For this container to be returned, the user must include the BuyingSummary.Include field in the request and set its value to true.
Output property: ReturnedWatchList - This container consists of the items on the eBay user's Watch List. This container will be returned if the eBay user has one or more items on their Watch List.

This container will not be returned in the response (even if there are items on the Watch List) if the DetailLevel value is set to ReturnSummary and the WatchList.Include field is omitted or set to false.
Output property: ReturnedBidList - This container consists of the auction items on which the eBay user has bid. This container will be returned if the eBay user has bid on one or more auction items.

This container will not be returned in the response (even if there are items on the Bid List) if the DetailLevel value is set to ReturnSummary and the BidList.Include field is omitted or set to false.
Output property: ReturnedBestOfferList - This container consists of the items on which the eBay user has made Best Offers. This container will be returned if the eBay user has made one or more Best Offers.

This container will not be returned in the response (even if user has made Best Offers) if the DetailLevel value is set to ReturnSummary and the BestOfferList.Include field is omitted or set to false.
Output property: ReturnedWonList - This container consists of the auction items on which the eBay user has won. This container will be returned if the eBay user has won one or more auction items.

This container will not be returned in the response (even if there are items on the Won List) if the DetailLevel value is set to ReturnSummary and the WonList.Include field is omitted or set to false.
Output property: ReturnedLostList - This container consists of the auction items on which the eBay user has bid on but lost. This container will be returned if the eBay user has lost one or more auction items.

This container will not be returned in the response (even if the buyer has lost one or more auction items) if the DetailLevel value is set to ReturnSummary and the LostList.Include field is omitted or set to false.
Output property: ReturnedFavoriteSearches - This container consists of the eBay user's saved searches. This container will be returned if the eBay user has one or more saved searches.

This container will not be returned in the response (even if the user has saved searches) if the DetailLevel value is set to ReturnSummary and the FavoriteSearches.Include field is omitted or set to false.

This container consists of the search name, search query, and other search elements. The user can copy and paste the URL in the SearchQuery field into a browser to view the search results again.
Output property: ReturnedFavoriteSellers - This container consists of the eBay user's saved sellers. This container will be returned if the eBay user has one or more saved sellers.

This container will not be returned in the response (even if the user has saved sellers) if the DetailLevel value is set to ReturnSummary and the FavoriteSellers.Include field is omitted or set to false.

This container consists of the saved sellers' user IDs and eBay Store names (if applicable).
Output property: ReturnedSecondChanceOffer - This container consists of the items on which the eBay user has received a Second Chance Offer. This container will be returned if the eBay user has made one or more Second Chance Offers.

This container will not be returned in the response (even if user has received Second Chance Offers) if the DetailLevel value is set to ReturnSummary and the SecondChanceOffer.Include field is omitted or set to false.
Output property: ReturnedBidAssistantList - This field is deprecated.
Output property: ReturnedDeletedFromWonList - This container consists of the auction items on which the eBay user has won but deleted from their My eBay page. This container will be returned if the eBay user has won one or more auction items but have deleted these items from My eBay.

This container will not be returned in the response (even if they have won and then deleted one or more items) if the DetailLevel value is set to ReturnSummary and the DeletedFromWonList.Include field is omitted or set to false.
Output property: ReturnedDeletedFromLostList - This container consists of the auction items on which the eBay user has lost and then deleted from their My eBay page. This container will be returned if the eBay user has lost one or more auction items and then deleted those items from My eBay.

This container will not be returned in the response (even if they have lost and then deleted one or more items) if the DetailLevel value is set to ReturnSummary and the DeletedFromLostList.Include field is omitted or set to false.
Output property: ReturnedUserDefinedList - This container consists of data for a user-defined list that was created by the user in My eBay. User-defined lists consists of a combination of items, saved sellers, and/or saved searches.

This container will not be returned in the response (even if one or more user-defined lists exist) if the DetailLevel value is set to ReturnSummary and the UserDefinedList.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
GetMyeBayBuyingCall()
          Constructor.
GetMyeBayBuyingCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 ItemListCustomizationType getBestOfferList()
          Gets the GetMyeBayBuyingRequestType.bestOfferList.
 BidAssistantListType getBidAssistantList()
          Gets the GetMyeBayBuyingRequestType.bidAssistantList.
 ItemListCustomizationType getBidList()
          Gets the GetMyeBayBuyingRequestType.bidList.
 ItemListCustomizationType getBuyingSummary()
          Gets the GetMyeBayBuyingRequestType.buyingSummary.
 ItemListCustomizationType getDeletedFromLostList()
          Gets the GetMyeBayBuyingRequestType.deletedFromLostList.
 ItemListCustomizationType getDeletedFromWonList()
          Gets the GetMyeBayBuyingRequestType.deletedFromWonList.
 MyeBaySelectionType getFavoriteSearches()
          Gets the GetMyeBayBuyingRequestType.favoriteSearches.
 MyeBaySelectionType getFavoriteSellers()
          Gets the GetMyeBayBuyingRequestType.favoriteSellers.
 java.lang.Boolean getHideVariations()
          Gets the GetMyeBayBuyingRequestType.hideVariations.
 ItemListCustomizationType getLostList()
          Gets the GetMyeBayBuyingRequestType.lostList.
 void getMyeBayBuying()
          Retrieves information regarding a user's buying activity, such as items they are watching, bidding on, have won, did not win, and have made Best Offers on.
 GetMyeBayBuyingRequestType getMyeBayBuyingRequest()
          Gets the GetMyeBayBuyingRequestType.myeBayBuyingRequest.
 PaginatedItemArrayType getReturnedBestOfferList()
          Valid after executing the API.
 BidGroupArrayType getReturnedBidAssistantList()
          Valid after executing the API.
 PaginatedItemArrayType getReturnedBidList()
          Valid after executing the API.
 BuyingSummaryType getReturnedBuyingSummary()
          Valid after executing the API.
 PaginatedItemArrayType getReturnedDeletedFromLostList()
          Valid after executing the API.
 PaginatedOrderTransactionArrayType getReturnedDeletedFromWonList()
          Valid after executing the API.
 MyeBayFavoriteSearchListType getReturnedFavoriteSearches()
          Valid after executing the API.
 MyeBayFavoriteSellerListType getReturnedFavoriteSellers()
          Valid after executing the API.
 GetMyeBayBuyingResponseType getReturnedGetMyeBayBuyingResponse()
          Valid after executing the API.
 PaginatedItemArrayType getReturnedLostList()
          Valid after executing the API.
 ItemType[] getReturnedSecondChanceOffer()
          Valid after executing the API.
 UserDefinedListType[] getReturnedUserDefinedList()
          Valid after executing the API.
 PaginatedItemArrayType getReturnedWatchList()
          Valid after executing the API.
 PaginatedOrderTransactionArrayType getReturnedWonList()
          Valid after executing the API.
 MyeBaySelectionType getSecondChanceOffer()
          Gets the GetMyeBayBuyingRequestType.secondChanceOffer.
 MyeBaySelectionType getUserDefinedLists()
          Gets the GetMyeBayBuyingRequestType.userDefinedLists.
 ItemListCustomizationType getWatchList()
          Gets the GetMyeBayBuyingRequestType.watchList.
 ItemListCustomizationType getWonList()
          Gets the GetMyeBayBuyingRequestType.wonList.
 void setBestOfferList(ItemListCustomizationType bestOfferList)
          Sets the GetMyeBayBuyingRequestType.bestOfferList.
 void setBidAssistantList(BidAssistantListType bidAssistantList)
          Sets the GetMyeBayBuyingRequestType.bidAssistantList.
 void setBidList(ItemListCustomizationType bidList)
          Sets the GetMyeBayBuyingRequestType.bidList.
 void setBuyingSummary(ItemListCustomizationType buyingSummary)
          Sets the GetMyeBayBuyingRequestType.buyingSummary.
 void setDeletedFromLostList(ItemListCustomizationType deletedFromLostList)
          Sets the GetMyeBayBuyingRequestType.deletedFromLostList.
 void setDeletedFromWonList(ItemListCustomizationType deletedFromWonList)
          Sets the GetMyeBayBuyingRequestType.deletedFromWonList.
 void setFavoriteSearches(MyeBaySelectionType favoriteSearches)
          Sets the GetMyeBayBuyingRequestType.favoriteSearches.
 void setFavoriteSellers(MyeBaySelectionType favoriteSellers)
          Sets the GetMyeBayBuyingRequestType.favoriteSellers.
 void setHideVariations(java.lang.Boolean hideVariations)
          Sets the GetMyeBayBuyingRequestType.hideVariations.
 void setLostList(ItemListCustomizationType lostList)
          Sets the GetMyeBayBuyingRequestType.lostList.
 void setMyeBayBuyingRequest(GetMyeBayBuyingRequestType myeBayBuyingRequest)
          Sets the GetMyeBayBuyingRequestType.myeBayBuyingRequest.
 void setSecondChanceOffer(MyeBaySelectionType secondChanceOffer)
          Sets the GetMyeBayBuyingRequestType.secondChanceOffer.
 void setUserDefinedLists(MyeBaySelectionType userDefinedLists)
          Sets the GetMyeBayBuyingRequestType.userDefinedLists.
 void setWatchList(ItemListCustomizationType watchList)
          Sets the GetMyeBayBuyingRequestType.watchList.
 void setWonList(ItemListCustomizationType wonList)
          Sets the GetMyeBayBuyingRequestType.wonList.
 
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

GetMyeBayBuyingCall

public GetMyeBayBuyingCall()
Constructor.


GetMyeBayBuyingCall

public GetMyeBayBuyingCall(ApiContext apiContext)
Constructor.

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

getMyeBayBuying

public void getMyeBayBuying()
                     throws ApiException,
                            SdkException,
                            java.lang.Exception
Retrieves information regarding a user's buying activity, such as items they are watching, bidding on, have won, did not win, and have made Best Offers on.

Throws:
ApiException
SdkException
java.lang.Exception

getMyeBayBuyingRequest

public GetMyeBayBuyingRequestType getMyeBayBuyingRequest()
Gets the GetMyeBayBuyingRequestType.myeBayBuyingRequest.

Returns:
GetMyeBayBuyingRequestType

setMyeBayBuyingRequest

public void setMyeBayBuyingRequest(GetMyeBayBuyingRequestType myeBayBuyingRequest)
Sets the GetMyeBayBuyingRequestType.myeBayBuyingRequest.

Parameters:
myeBayBuyingRequest - GetMyeBayBuyingRequestType

getBestOfferList

public ItemListCustomizationType getBestOfferList()
Gets the GetMyeBayBuyingRequestType.bestOfferList.

Returns:
ItemListCustomizationType

setBestOfferList

public void setBestOfferList(ItemListCustomizationType bestOfferList)
Sets the GetMyeBayBuyingRequestType.bestOfferList.

Parameters:
bestOfferList - ItemListCustomizationType

getBidAssistantList

public BidAssistantListType getBidAssistantList()
Gets the GetMyeBayBuyingRequestType.bidAssistantList.

Returns:
BidAssistantListType

setBidAssistantList

public void setBidAssistantList(BidAssistantListType bidAssistantList)
Sets the GetMyeBayBuyingRequestType.bidAssistantList.

Parameters:
bidAssistantList - BidAssistantListType

getBidList

public ItemListCustomizationType getBidList()
Gets the GetMyeBayBuyingRequestType.bidList.

Returns:
ItemListCustomizationType

setBidList

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

Parameters:
bidList - ItemListCustomizationType

getBuyingSummary

public ItemListCustomizationType getBuyingSummary()
Gets the GetMyeBayBuyingRequestType.buyingSummary.

Returns:
ItemListCustomizationType

setBuyingSummary

public void setBuyingSummary(ItemListCustomizationType buyingSummary)
Sets the GetMyeBayBuyingRequestType.buyingSummary.

Parameters:
buyingSummary - ItemListCustomizationType

getDeletedFromLostList

public ItemListCustomizationType getDeletedFromLostList()
Gets the GetMyeBayBuyingRequestType.deletedFromLostList.

Returns:
ItemListCustomizationType

setDeletedFromLostList

public void setDeletedFromLostList(ItemListCustomizationType deletedFromLostList)
Sets the GetMyeBayBuyingRequestType.deletedFromLostList.

Parameters:
deletedFromLostList - ItemListCustomizationType

getDeletedFromWonList

public ItemListCustomizationType getDeletedFromWonList()
Gets the GetMyeBayBuyingRequestType.deletedFromWonList.

Returns:
ItemListCustomizationType

setDeletedFromWonList

public void setDeletedFromWonList(ItemListCustomizationType deletedFromWonList)
Sets the GetMyeBayBuyingRequestType.deletedFromWonList.

Parameters:
deletedFromWonList - ItemListCustomizationType

getFavoriteSearches

public MyeBaySelectionType getFavoriteSearches()
Gets the GetMyeBayBuyingRequestType.favoriteSearches.

Returns:
MyeBaySelectionType

setFavoriteSearches

public void setFavoriteSearches(MyeBaySelectionType favoriteSearches)
Sets the GetMyeBayBuyingRequestType.favoriteSearches.

Parameters:
favoriteSearches - MyeBaySelectionType

getFavoriteSellers

public MyeBaySelectionType getFavoriteSellers()
Gets the GetMyeBayBuyingRequestType.favoriteSellers.

Returns:
MyeBaySelectionType

setFavoriteSellers

public void setFavoriteSellers(MyeBaySelectionType favoriteSellers)
Sets the GetMyeBayBuyingRequestType.favoriteSellers.

Parameters:
favoriteSellers - MyeBaySelectionType

getHideVariations

public java.lang.Boolean getHideVariations()
Gets the GetMyeBayBuyingRequestType.hideVariations.

Returns:
Boolean

setHideVariations

public void setHideVariations(java.lang.Boolean hideVariations)
Sets the GetMyeBayBuyingRequestType.hideVariations.

Parameters:
hideVariations - Boolean

getLostList

public ItemListCustomizationType getLostList()
Gets the GetMyeBayBuyingRequestType.lostList.

Returns:
ItemListCustomizationType

setLostList

public void setLostList(ItemListCustomizationType lostList)
Sets the GetMyeBayBuyingRequestType.lostList.

Parameters:
lostList - ItemListCustomizationType

getSecondChanceOffer

public MyeBaySelectionType getSecondChanceOffer()
Gets the GetMyeBayBuyingRequestType.secondChanceOffer.

Returns:
MyeBaySelectionType

setSecondChanceOffer

public void setSecondChanceOffer(MyeBaySelectionType secondChanceOffer)
Sets the GetMyeBayBuyingRequestType.secondChanceOffer.

Parameters:
secondChanceOffer - MyeBaySelectionType

getUserDefinedLists

public MyeBaySelectionType getUserDefinedLists()
Gets the GetMyeBayBuyingRequestType.userDefinedLists.

Returns:
MyeBaySelectionType

setUserDefinedLists

public void setUserDefinedLists(MyeBaySelectionType userDefinedLists)
Sets the GetMyeBayBuyingRequestType.userDefinedLists.

Parameters:
userDefinedLists - MyeBaySelectionType

getWatchList

public ItemListCustomizationType getWatchList()
Gets the GetMyeBayBuyingRequestType.watchList.

Returns:
ItemListCustomizationType

setWatchList

public void setWatchList(ItemListCustomizationType watchList)
Sets the GetMyeBayBuyingRequestType.watchList.

Parameters:
watchList - ItemListCustomizationType

getWonList

public ItemListCustomizationType getWonList()
Gets the GetMyeBayBuyingRequestType.wonList.

Returns:
ItemListCustomizationType

setWonList

public void setWonList(ItemListCustomizationType wonList)
Sets the GetMyeBayBuyingRequestType.wonList.

Parameters:
wonList - ItemListCustomizationType

getReturnedGetMyeBayBuyingResponse

public GetMyeBayBuyingResponseType getReturnedGetMyeBayBuyingResponse()
Valid after executing the API. Gets the returned GetMyeBayBuyingResponseType.

Returns:
GetMyeBayBuyingResponseType

getReturnedBestOfferList

public PaginatedItemArrayType getReturnedBestOfferList()
Valid after executing the API. Gets the returned GetMyeBayBuyingResponseType.returnedBestOfferList.

Returns:
PaginatedItemArrayType

getReturnedBidAssistantList

public BidGroupArrayType getReturnedBidAssistantList()
Valid after executing the API. Gets the returned GetMyeBayBuyingResponseType.returnedBidAssistantList.

Returns:
BidGroupArrayType

getReturnedBidList

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

Returns:
PaginatedItemArrayType

getReturnedBuyingSummary

public BuyingSummaryType getReturnedBuyingSummary()
Valid after executing the API. Gets the returned GetMyeBayBuyingResponseType.returnedBuyingSummary.

Returns:
BuyingSummaryType

getReturnedDeletedFromLostList

public PaginatedItemArrayType getReturnedDeletedFromLostList()
Valid after executing the API. Gets the returned GetMyeBayBuyingResponseType.returnedDeletedFromLostList.

Returns:
PaginatedItemArrayType

getReturnedDeletedFromWonList

public PaginatedOrderTransactionArrayType getReturnedDeletedFromWonList()
Valid after executing the API. Gets the returned GetMyeBayBuyingResponseType.returnedDeletedFromWonList.

Returns:
PaginatedOrderTransactionArrayType

getReturnedFavoriteSearches

public MyeBayFavoriteSearchListType getReturnedFavoriteSearches()
Valid after executing the API. Gets the returned GetMyeBayBuyingResponseType.returnedFavoriteSearches.

Returns:
MyeBayFavoriteSearchListType

getReturnedFavoriteSellers

public MyeBayFavoriteSellerListType getReturnedFavoriteSellers()
Valid after executing the API. Gets the returned GetMyeBayBuyingResponseType.returnedFavoriteSellers.

Returns:
MyeBayFavoriteSellerListType

getReturnedLostList

public PaginatedItemArrayType getReturnedLostList()
Valid after executing the API. Gets the returned GetMyeBayBuyingResponseType.returnedLostList.

Returns:
PaginatedItemArrayType

getReturnedSecondChanceOffer

public ItemType[] getReturnedSecondChanceOffer()
Valid after executing the API. Gets the returned GetMyeBayBuyingResponseType.returnedSecondChanceOffer.

Returns:
ItemType[]

getReturnedUserDefinedList

public UserDefinedListType[] getReturnedUserDefinedList()
Valid after executing the API. Gets the returned GetMyeBayBuyingResponseType.returnedUserDefinedList.

Returns:
UserDefinedListType[]

getReturnedWatchList

public PaginatedItemArrayType getReturnedWatchList()
Valid after executing the API. Gets the returned GetMyeBayBuyingResponseType.returnedWatchList.

Returns:
PaginatedItemArrayType

getReturnedWonList

public PaginatedOrderTransactionArrayType getReturnedWonList()
Valid after executing the API. Gets the returned GetMyeBayBuyingResponseType.returnedWonList.

Returns:
PaginatedOrderTransactionArrayType

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.