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 - Returns the list of items being watched by the user.

Set Include to true to return the default response set.
Input property: BidList - Returns the list of items on which the user has bid.

Set Include to true to return the default response set.
Input property: BestOfferList - Returns the list of items on which the user has placed Best Offers.

Set Include to true to return the default response set.
Input property: WonList - Returns the list of items on which the use has bid.

Set Include to true to return the default response set.
Input property: LostList - Returns the list of items on which the user has bid on and lost.

Set Include to true to return the default response set.
Input property: FavoriteSearches - Returns the list of searches that the user has saved in My eBay. Returned only if the user has saved searches.

Set Include to true to return the default response set.
Input property: FavoriteSellers - Returns the list of favorite sellers that the user has saved in My eBay. Returned only if the user has saved a list of favorite sellers.

Set Include to true to return the default response set.
Input property: SecondChanceOffer - Returns the list of Second Chance Offers made by the user. Returned only if the user has made Second Chance Offers.

Set Include to true to return the default response set.
Input property: BidAssistantList - This field is deprecated.
Input property: DeletedFromWonList - Returns the list of items the user has won, and subsequently deleted from their My eBay page.

Set Include to true to return the default response set.
Input property: DeletedFromLostList - Returns the list of items (auctions) the user did not win and were subsequently deleted from their My eBay page.

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

Note: The buying summary container is not included in the response by default. To include a BuyingSummary element, add an Include field set to true to the request.
Input property: UserDefinedLists - Returns the user defined lists, which are lists created by the user in the eBay UI and filled with items, or sellers, or searches using the "Add to List" feature.

Set Include to true to return the default response set.
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: ReturnedBuyingSummary - Contains a summary of the items the user has bid on. Returned at all detail levels.
Output property: ReturnedWatchList - Contains the items the user is watching. Only returned if items exist that meet the request criteria.
Output property: ReturnedBidList - Contains all the items the buyer has bid on. Only returned if items exist that meet the request criteria.
Output property: ReturnedBestOfferList - Contains the items the user has placed Best Offers on. Only returned if items exist that meet the request criteria.
Output property: ReturnedWonList - Contains the items the user has bid on and won. Only returned if items exist that meet the request criteria.
Output property: ReturnedLostList - Contains the items the user has bid on and lost. Only returned if items exist that meet the request criteria.
Output property: ReturnedFavoriteSearches - Contains a list of the user's favorite searches. Only returned if the user has Favorite Searches. The search name, search query, and search elements, such as QueryKeywords, SortOrder, and Condition are returned.

You can paste the Search Query response, that comes back as a URL, into a browser to re-play the Favorite Search.

The search elements that are returned by this call can be used as input for the Shopping Web Service FindItemsAdvanced request.
Output property: ReturnedFavoriteSellers - Contains a list of the user's favorite sellers. Only returned if items exist that meet the request criteria.
Output property: ReturnedSecondChanceOffer - Contains the list of Second Chance Offers the user has received. Only returned if items exist that meet the request criteria.
Output property: ReturnedBidAssistantList - This field is deprecated.
Output property: ReturnedDeletedFromWonList - Contains the items the buyer has bid on, won, and deleted from My eBay. Only returned if items exist that meet the request criteria.
Output property: ReturnedDeletedFromLostList - Contains the items the buyer has bid on, lost, and deleted from My eBay. Only returned if items exist that meet the request criteria.
Output property: ReturnedUserDefinedList - Contains the items, searches, or sellers that the user has saved to this list using the "Add to list" feature. The name of the list is given by the "Name" element. Returned only if UserDefineLists is specified in the request.

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.
 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(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, 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

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,
                            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
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 Boolean getHideVariations()
Gets the GetMyeBayBuyingRequestType.hideVariations.

Returns:
Boolean

setHideVariations

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