Changes since
the last release

com.ebay.sdk.call
Class GetUserPreferencesCall

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

public class GetUserPreferencesCall
extends ApiCall

Wrapper class of the GetUserPreferences 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: ShowBidderNoticePreferences - If included and set to true, the seller's preference for receiving contact information for unsuccessful bidders is returned in the response.
Input property: ShowCombinedPaymentPreferences - If included and set to true, the seller's combined invoice preferences are returned in the response. These preferences are used to allow Combined Invoice orders.

Input property: ShowCrossPromotionPreferences - This field is deprecated.
Input property: ShowSellerPaymentPreferences - If included and set to true, the seller's payment preferences are returned in the response.
Input property: ShowEndOfAuctionEmailPreferences - If included and set to true, the seller's preferences for the end-of-auction email sent to the winning bidder is returned in the response. These preferences are only applicable for auction listings.
Input property: ShowSellerFavoriteItemPreferences - If included and set to true, the seller's favorite item preferences are returned in the response.
Input property: ShowProStoresPreferences - This field is deprecated.
Input property: ShowEmailShipmentTrackingNumberPreference - If included and set to true, the seller's preference for sending an email to the buyer with the shipping tracking number is returned in the response.
Input property: ShowRequiredShipPhoneNumberPreference - If included and set to true, the seller's preference for requiring that the buyer supply a shipping phone number upon checkout is returned in the response. Some shipping carriers require the receiver's phone number.
Input property: ShowSellerExcludeShipToLocationPreference - If included and set to true, all of the seller's excluded shipping locations are returned in the response. The returned list mirrors the seller's current Exclude shipping locations list in My eBay's Shipping Preferences. An excluded shipping location in My eBay can be an entire geographical region (such as Middle East) or only an individual country (such as Iraq). Sellers can override these default settings for an individual listing by using the Item.ShippingDetails.ExcludeShipToLocation field in the AddItem family of calls.
Input property: ShowUnpaidItemAssistancePreference - If included and set to true, the seller's Unpaid Item Assistant preferences are returned in the response. The Unpaid Item Assistant automatically opens an Unpaid Item dispute on the behalf of the seller.

Note: To return the list of buyers excluded from the Unpaid Item Assistant mechanism, the ShowUnpaidItemAssistanceExclusionList field must also be included and set to true in the request. Excluded buyers can be viewed in the UnpaidItemAssistancePreferences.ExcludedUser field.
Input property: ShowPurchaseReminderEmailPreferences - If included and set to true, the seller's preference for sending a purchase reminder email to buyers is returned in the response.
Input property: ShowUnpaidItemAssistanceExclusionList - If included and set to true, the list of eBay user IDs on the Unpaid Item Assistant Excluded User list is returned through the UnpaidItemAssistancePreferences.ExcludedUser field in the response.

For excluded users, an Unpaid Item dispute is not automatically filed through the UPI Assistance mechanism. The Excluded User list is managed through the SetUserPreferences call.

Note: To return the list of buyers excluded from the Unpaid Item Assistant mechanism, the ShowUnpaidItemAssistancePreference field must also be included and set to true in the request.
Input property: ShowSellerProfilePreferences - If this flag is included and set to true, the seller's Business Policies profile information is returned in the response. This information includes a flag that indicates whether or not the seller has opted into Business Policies, as well as Business Policies profiles (payment, shipping, and return policy) active on the seller's account.
Input property: ShowSellerReturnPreferences - If this flag is included and set to true, the SellerReturnPreferences container is returned in the response and indicates whether or not the seller has opted in to eBay Managed Returns.

eBay Managed Returns are currently only available on the US, UK, DE, AU, and CA (English and French) sites.
Input property: ShowGlobalShippingProgramPreference - If this flag is included and set to true, the seller's preference for offering the Global Shipping Program to international buyers will be returned in OfferGlobalShippingProgramPreference.
Input property: ShowDispatchCutoffTimePreferences - If included and set to true, the seller's same-day handling cutoff time is returned in DispatchCutoffTimePreference.CutoffTime.

Note: This field is not applicable for sellers who have opted into the Handling Time Option of eBay Guaranteed Delivery, as this field only shows a single order cutoff time, but with the Handling Time Option, a seller can set a different order cutoff time for each business day. Currently, eBay Guaranteed Delivery is only available in the US.

Input property: ShowGlobalShippingProgramListingPreference - If included and set to true, the GlobalShippingProgramListingPreference field is returned. A returned value of true indicates that the seller's new listings will enable the Global Shipping Program by default.
Input property: ShowOverrideGSPServiceWithIntlServicePreference - If included and set to true, the OverrideGSPServiceWithIntlServicePreference field is returned. A returned value of true indicates that for the seller's listings that specify an international shipping service for any Global Shipping-eligible country, the specified service will take precedence and be the listing's default international shipping option for buyers in that country, rather than the Global Shipping Program.

A returned value of false indicates that the Global Shipping program will take precedence over any international shipping service as the default option in Global Shipping-eligible listings for shipping to any Global Shipping-eligible country.
Input property: ShowPickupDropoffPreferences - If included and set to true, the PickupDropoffSellerPreference field is returned. A returned value of true indicates that the seller's new listings will by default be eligible to be evaluated for the Click and Collect feature.

With the Click and Collect feature, a buyer can purchase certain items on eBay and collect them at a local store. Buyers are notified by eBay once their items are available. The Click and Collect feature is only available to large merchants on the eBay UK (site ID 3), eBay Australia (Site ID 15), and eBay Germany (Site ID 77) sites.

Note: The Click and Collect program no longer allows sellers to set the Click and Collect preference at the listing level.
Input property: ShowOutOfStockControlPreference - If included and set to true, the seller's preferences related to the Out-of-Stock feature will be returned. This feature is set using the SetUserPreferences call.
Input property: ShoweBayPLUSPreference - To determine whether a seller can offer eBay Plus in qualified listings, include this field and set it to true.

eBay Plus is a premium account option for buyers, which provides benefits such as fast free domestic shipping and free returns on selected items. Top Rated eBay sellers must opt in to eBay Plus, and can offer the program on a per-listing basis.

The eBayPLUSPreference container is returned in the response with information about each country where the seller is eligible to offer eBay Plus on listings (one eBayPLUSPreference container per country), as well as the seller's opt-in status and listing preference for each country.

Note: Currently, eBay Plus is available only to buyers in Germany, Austria, and Australia.
Output property: ReturnedBidderNoticePreferences - Container consisting of the seller's preference for receiving contact information for unsuccessful bidders. This container is returned when ShowBidderNoticePreferences is included and set to true in the request. This preference is only applicable for auction listings.
Output property: ReturnedCombinedPaymentPreferences - Container consisting of the seller's Combined Invoice preferences. These preferences are used to allow Combined Invoice orders. This container is returned when ShowCombinedPaymentPreferences is included and set to true in the request.
Output property: ReturnedCrossPromotionPreferences - This container is deprecated.
Output property: ReturnedSellerPaymentPreferences - Container consisting of the seller's payment preferences. This container is returned when ShowSellerPaymentPreferences is included and set to true in the request.
Output property: ReturnedSellerFavoriteItemPreferences - Container consisting of the seller's preferences for displaying items on a buyer's Favorite Sellers' Items page or Favorite Sellers' Items digest. This container is returned when ShowSellerFavoriteItemPreferences is included and set to true in the request.
Output property: ReturnedEndOfAuctionEmailPreferences - Container consisting of the seller's preferences for the end-of-auction email sent to the winning bidder. This container is returned when ShowEndOfAuctionEmailPreferences is included and set to true in the request. These preferences are only applicable for auction listings.
Output property: ReturnedEmailShipmentTrackingNumberPreference - Container consisting of the seller's preference for sending an email to the buyer with the shipment tracking number. This container is returned when ShowEmailShipmentTrackingNumberPreference is included and set to true in the request.
Output property: ReturnedRequiredShipPhoneNumberPreference - Container consisting of the seller's preference for requiring that the buyer supply a shipping phone number upon checkout. Some shipping carriers require the receiver's phone number. This container is returned when ShowRequiredShipPhoneNumberPreference is included and set to true in the request.
Output property: ReturnedProStoresPreference - This field is deprecated.
Output property: ReturnedUnpaidItemAssistancePreferences - Container consisting of a seller's Unpaid Item Assistant preferences. The Unpaid Item Assistant automatically opens an Unpaid Item dispute on the behalf of the seller. This container is returned if ShowUnpaidItemAssistancePreference is included and set to true in the request.

Note: To return the list of buyers excluded from the Unpaid Item Assistant mechanism, the ShowUnpaidItemAssistanceExclusionList field must also be included and set to true in the request. Excluded buyers can be viewed in the UnpaidItemAssistancePreferences.ExcludedUser field.
Output property: ReturnedSellerExcludeShipToLocationPreferences - Container consisting of a list of the seller's excluded shipping locations. The returned list mirrors the seller's current Exclude shipping locations list in My eBay's shipping preferences. An excluded shipping location in My eBay can be an entire geographical region (such as Middle East) or only an individual country (such as Iraq).

Sellers can override these default settings for an individual listing by using the Item.ShippingDetails.ExcludeShipToLocation field in the Add/Revise/Relist calls. This container is returned if the ShowSellerExcludeShipToLocationPreference field is included and set to true in the request.
Output property: ReturnedPurchaseReminderEmailPreferences - Container consisting of a seller's preference for sending a purchase reminder email to buyers. This container is returned if the ShowPurchaseReminderEmailPreferences field is included and set to true in the request.
Output property: ReturnedSellerThirdPartyCheckoutDisabled - This field is deprecated along with third-party checkout.
Output property: ReturnedSellerProfilePreferences - Parent response container consisting of high-level information for all Business Policies defined for the user's account. This container is returned if ShowSellerProfilePreferences is included and set to true in the GetUserPreferences request (and one or more Business Policies are defined for the user's account).
Output property: ReturnedSellerReturnPreferences - Container consisting of the OptedIn flag that indicates whether or not the seller has opted in to eBay Managed Returns. This container is only returned if ShowSellerReturnPreferences is included and set to true in the request.
Output property: ReturnedOfferGlobalShippingProgramPreference - This flag indicates whether the seller has opted in to the Global Shipping Program and is able to offer global shipping to international buyers. Returned when ShowGlobalShippingProgramPreference is included and set to true.
Output property: ReturnedDispatchCutoffTimePreference - Contains information about a seller's order cutoff time preferences for same-day shipping. If the seller specifies a value of '0' in Item.DispatchTimeMax to offer same-day handling when listing an item, the seller's shipping time commitment depends on the order cutoff time set for the listing site, as indicated by DispatchCutoffTimePreference.CutoffTime. Returned when ShowDispatchCutoffTimePreferences is included and set to true.

Note: The order cutoff is may not be accurate for sellers who have opted into the Handling Time Option of eBay Guaranteed Delivery, as this field only shows a single order cutoff time, but with the Handling Time Option, a seller can set a different order cutoff time for each business day. Currently, eBay Guaranteed Delivery is only available in the US.

Output property: ReturnedGlobalShippingProgramListingPreference - If the ShowGlobalShippingProgramListingPreference field is submitted and set to true, this flag is returned. A returned value of true indicates that the seller's new listings will enable the Global Shipping Program by default.
Output property: ReturnedOverrideGSPServiceWithIntlServicePreference - If the ShowOverrideGSPServiceWithIntlServicePreference field is submitted and set to true, this flag is returned. A returned value of true indicates that for the seller's listings that specify an international shipping service for any Global Shipping-eligible country, the specified service will take precedence and be the listing's default international shipping option for buyers in that country, rather than the Global Shipping Program.

A returned value of false indicates that the Global Shipping program will take precedence over any international shipping service as the default option in Global Shipping-eligible listings for shipping to any Global Shipping-eligible country.
Output property: ReturnedPickupDropoffSellerPreference - This boolean field is returned if the ShowPickupDropoffPreferences field is included and set to true in the request. This field will be returned as true if the seller has enabled the Click and Collect feature at the account level. All of the seller's new listings will by default be eligible to be evaluated for the Click and Collect feature. With the Click and Collect feature, a buyer can purchase certain items on eBay and collect them at a local store. Buyers are notified by eBay once their items are available. The Click and Collect feature is only available to large merchants on the eBay UK (site ID 3), eBay Australia (Site ID 15), and eBay Germany (Site ID 77) sites.

Note: The Click and Collect program no longer allows sellers to set the Click and Collect preference at the listing level.
Output property: ReturnedOutOfStockControlPreference - This boolean field is returned if the ShowOutOfStockControlPreference field is included and set to true in the request. This field will be returned as true if the seller has set SetUserPreferences.OutOfStockControlPreference to true.
Output property: ReturnedEBayPLUSPreference - Contains information about each country where the seller is eligible to offer eBay Plus on listings (one eBayPLUSPreference container per country), as well as the seller's opt-in status and listing preference for each country.

eBay Plus is a premium account option for buyers, which provides benefits such as fast free domestic shipping and free returns on selected items. Top Rated eBay sellers must opt in to eBay Plus to offer the program on a per-listing basis.

Note: Currently, eBay Plus is available only to buyers in Germany, Austria, and Australia.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
GetUserPreferencesCall()
          Constructor.
GetUserPreferencesCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 BidderNoticePreferencesType getReturnedBidderNoticePreferences()
          Valid after executing the API.
 CombinedPaymentPreferencesType getReturnedCombinedPaymentPreferences()
          Valid after executing the API.
 CrossPromotionPreferencesType getReturnedCrossPromotionPreferences()
          Valid after executing the API.
 DispatchCutoffTimePreferencesType getReturnedDispatchCutoffTimePreference()
          Valid after executing the API.
 EBayPLUSPreferenceType[] getReturnedEBayPLUSPreference()
          Valid after executing the API.
 java.lang.Boolean getReturnedEmailShipmentTrackingNumberPreference()
          Valid after executing the API.
 EndOfAuctionEmailPreferencesType getReturnedEndOfAuctionEmailPreferences()
          Valid after executing the API.
 java.lang.Boolean getReturnedGlobalShippingProgramListingPreference()
          Valid after executing the API.
 java.lang.Boolean getReturnedOfferGlobalShippingProgramPreference()
          Valid after executing the API.
 java.lang.Boolean getReturnedOutOfStockControlPreference()
          Valid after executing the API.
 java.lang.Boolean getReturnedOverrideGSPServiceWithIntlServicePreference()
          Valid after executing the API.
 java.lang.Boolean getReturnedPickupDropoffSellerPreference()
          Valid after executing the API.
 ProStoresCheckoutPreferenceType getReturnedProStoresPreference()
          Valid after executing the API.
 PurchaseReminderEmailPreferencesType getReturnedPurchaseReminderEmailPreferences()
          Valid after executing the API.
 java.lang.Boolean getReturnedRequiredShipPhoneNumberPreference()
          Valid after executing the API.
 SellerExcludeShipToLocationPreferencesType getReturnedSellerExcludeShipToLocationPreferences()
          Valid after executing the API.
 SellerFavoriteItemPreferencesType getReturnedSellerFavoriteItemPreferences()
          Valid after executing the API.
 SellerPaymentPreferencesType getReturnedSellerPaymentPreferences()
          Valid after executing the API.
 SellerProfilePreferencesType getReturnedSellerProfilePreferences()
          Valid after executing the API.
 SellerReturnPreferencesType getReturnedSellerReturnPreferences()
          Valid after executing the API.
 java.lang.Boolean getReturnedSellerThirdPartyCheckoutDisabled()
          Valid after executing the API.
 UnpaidItemAssistancePreferencesType getReturnedUnpaidItemAssistancePreferences()
          Valid after executing the API.
 java.lang.Boolean getShowBidderNoticePreferences()
          Gets the GetUserPreferencesRequestType.showBidderNoticePreferences.
 java.lang.Boolean getShowCombinedPaymentPreferences()
          Gets the GetUserPreferencesRequestType.showCombinedPaymentPreferences.
 java.lang.Boolean getShowCrossPromotionPreferences()
          Gets the GetUserPreferencesRequestType.showCrossPromotionPreferences.
 java.lang.Boolean getShowDispatchCutoffTimePreferences()
          Gets the GetUserPreferencesRequestType.showDispatchCutoffTimePreferences.
 java.lang.Boolean getShoweBayPLUSPreference()
          Gets the GetUserPreferencesRequestType.showeBayPLUSPreference.
 java.lang.Boolean getShowEmailShipmentTrackingNumberPreference()
          Gets the GetUserPreferencesRequestType.showEmailShipmentTrackingNumberPreference.
 java.lang.Boolean getShowEndOfAuctionEmailPreferences()
          Gets the GetUserPreferencesRequestType.showEndOfAuctionEmailPreferences.
 java.lang.Boolean getShowGlobalShippingProgramListingPreference()
          Gets the GetUserPreferencesRequestType.showGlobalShippingProgramListingPreference.
 java.lang.Boolean getShowGlobalShippingProgramPreference()
          Gets the GetUserPreferencesRequestType.showGlobalShippingProgramPreference.
 java.lang.Boolean getShowOutOfStockControlPreference()
          Gets the GetUserPreferencesRequestType.showOutOfStockControlPreference.
 java.lang.Boolean getShowOverrideGSPServiceWithIntlServicePreference()
          Gets the GetUserPreferencesRequestType.showOverrideGSPServiceWithIntlServicePreference.
 java.lang.Boolean getShowPickupDropoffPreferences()
          Gets the GetUserPreferencesRequestType.showPickupDropoffPreferences.
 java.lang.Boolean getShowProStoresPreferences()
          Gets the GetUserPreferencesRequestType.showProStoresPreferences.
 java.lang.Boolean getShowPurchaseReminderEmailPreferences()
          Gets the GetUserPreferencesRequestType.showPurchaseReminderEmailPreferences.
 java.lang.Boolean getShowRequiredShipPhoneNumberPreference()
          Gets the GetUserPreferencesRequestType.showRequiredShipPhoneNumberPreference.
 java.lang.Boolean getShowSellerExcludeShipToLocationPreference()
          Gets the GetUserPreferencesRequestType.showSellerExcludeShipToLocationPreference.
 java.lang.Boolean getShowSellerFavoriteItemPreferences()
          Gets the GetUserPreferencesRequestType.showSellerFavoriteItemPreferences.
 java.lang.Boolean getShowSellerPaymentPreferences()
          Gets the GetUserPreferencesRequestType.showSellerPaymentPreferences.
 java.lang.Boolean getShowSellerProfilePreferences()
          Gets the GetUserPreferencesRequestType.showSellerProfilePreferences.
 java.lang.Boolean getShowSellerReturnPreferences()
          Gets the GetUserPreferencesRequestType.showSellerReturnPreferences.
 java.lang.Boolean getShowUnpaidItemAssistanceExclusionList()
          Gets the GetUserPreferencesRequestType.showUnpaidItemAssistanceExclusionList.
 java.lang.Boolean getShowUnpaidItemAssistancePreference()
          Gets the GetUserPreferencesRequestType.showUnpaidItemAssistancePreference.
 void getUserPreferences()
          Retrieves the specified user preferences for the authenticated caller.
 void setShowBidderNoticePreferences(java.lang.Boolean showBidderNoticePreferences)
          Sets the GetUserPreferencesRequestType.showBidderNoticePreferences.
 void setShowCombinedPaymentPreferences(java.lang.Boolean showCombinedPaymentPreferences)
          Sets the GetUserPreferencesRequestType.showCombinedPaymentPreferences.
 void setShowCrossPromotionPreferences(java.lang.Boolean showCrossPromotionPreferences)
          Sets the GetUserPreferencesRequestType.showCrossPromotionPreferences.
 void setShowDispatchCutoffTimePreferences(java.lang.Boolean showDispatchCutoffTimePreferences)
          Sets the GetUserPreferencesRequestType.showDispatchCutoffTimePreferences.
 void setShoweBayPLUSPreference(java.lang.Boolean showeBayPLUSPreference)
          Sets the GetUserPreferencesRequestType.showeBayPLUSPreference.
 void setShowEmailShipmentTrackingNumberPreference(java.lang.Boolean showEmailShipmentTrackingNumberPreference)
          Sets the GetUserPreferencesRequestType.showEmailShipmentTrackingNumberPreference.
 void setShowEndOfAuctionEmailPreferences(java.lang.Boolean showEndOfAuctionEmailPreferences)
          Sets the GetUserPreferencesRequestType.showEndOfAuctionEmailPreferences.
 void setShowGlobalShippingProgramListingPreference(java.lang.Boolean showGlobalShippingProgramListingPreference)
          Sets the GetUserPreferencesRequestType.showGlobalShippingProgramListingPreference.
 void setShowGlobalShippingProgramPreference(java.lang.Boolean showGlobalShippingProgramPreference)
          Sets the GetUserPreferencesRequestType.showGlobalShippingProgramPreference.
 void setShowOutOfStockControlPreference(java.lang.Boolean showOutOfStockControlPreference)
          Sets the GetUserPreferencesRequestType.showOutOfStockControlPreference.
 void setShowOverrideGSPServiceWithIntlServicePreference(java.lang.Boolean showOverrideGSPServiceWithIntlServicePreference)
          Sets the GetUserPreferencesRequestType.showOverrideGSPServiceWithIntlServicePreference.
 void setShowPickupDropoffPreferences(java.lang.Boolean showPickupDropoffPreferences)
          Sets the GetUserPreferencesRequestType.showPickupDropoffPreferences.
 void setShowProStoresPreferences(java.lang.Boolean showProStoresPreferences)
          Sets the GetUserPreferencesRequestType.showProStoresPreferences.
 void setShowPurchaseReminderEmailPreferences(java.lang.Boolean showPurchaseReminderEmailPreferences)
          Sets the GetUserPreferencesRequestType.showPurchaseReminderEmailPreferences.
 void setShowRequiredShipPhoneNumberPreference(java.lang.Boolean showRequiredShipPhoneNumberPreference)
          Sets the GetUserPreferencesRequestType.showRequiredShipPhoneNumberPreference.
 void setShowSellerExcludeShipToLocationPreference(java.lang.Boolean showSellerExcludeShipToLocationPreference)
          Sets the GetUserPreferencesRequestType.showSellerExcludeShipToLocationPreference.
 void setShowSellerFavoriteItemPreferences(java.lang.Boolean showSellerFavoriteItemPreferences)
          Sets the GetUserPreferencesRequestType.showSellerFavoriteItemPreferences.
 void setShowSellerPaymentPreferences(java.lang.Boolean showSellerPaymentPreferences)
          Sets the GetUserPreferencesRequestType.showSellerPaymentPreferences.
 void setShowSellerProfilePreferences(java.lang.Boolean showSellerProfilePreferences)
          Sets the GetUserPreferencesRequestType.showSellerProfilePreferences.
 void setShowSellerReturnPreferences(java.lang.Boolean showSellerReturnPreferences)
          Sets the GetUserPreferencesRequestType.showSellerReturnPreferences.
 void setShowUnpaidItemAssistanceExclusionList(java.lang.Boolean showUnpaidItemAssistanceExclusionList)
          Sets the GetUserPreferencesRequestType.showUnpaidItemAssistanceExclusionList.
 void setShowUnpaidItemAssistancePreference(java.lang.Boolean showUnpaidItemAssistancePreference)
          Sets the GetUserPreferencesRequestType.showUnpaidItemAssistancePreference.
 
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

GetUserPreferencesCall

public GetUserPreferencesCall()
Constructor.


GetUserPreferencesCall

public GetUserPreferencesCall(ApiContext apiContext)
Constructor.

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

getUserPreferences

public void getUserPreferences()
                        throws ApiException,
                               SdkException,
                               java.lang.Exception
Retrieves the specified user preferences for the authenticated caller.

Throws:
ApiException
SdkException
java.lang.Exception

getShowBidderNoticePreferences

public java.lang.Boolean getShowBidderNoticePreferences()
Gets the GetUserPreferencesRequestType.showBidderNoticePreferences.

Returns:
Boolean

setShowBidderNoticePreferences

public void setShowBidderNoticePreferences(java.lang.Boolean showBidderNoticePreferences)
Sets the GetUserPreferencesRequestType.showBidderNoticePreferences.

Parameters:
showBidderNoticePreferences - Boolean

getShowCombinedPaymentPreferences

public java.lang.Boolean getShowCombinedPaymentPreferences()
Gets the GetUserPreferencesRequestType.showCombinedPaymentPreferences.

Returns:
Boolean

setShowCombinedPaymentPreferences

public void setShowCombinedPaymentPreferences(java.lang.Boolean showCombinedPaymentPreferences)
Sets the GetUserPreferencesRequestType.showCombinedPaymentPreferences.

Parameters:
showCombinedPaymentPreferences - Boolean

getShowCrossPromotionPreferences

public java.lang.Boolean getShowCrossPromotionPreferences()
Gets the GetUserPreferencesRequestType.showCrossPromotionPreferences.

Returns:
Boolean

setShowCrossPromotionPreferences

public void setShowCrossPromotionPreferences(java.lang.Boolean showCrossPromotionPreferences)
Sets the GetUserPreferencesRequestType.showCrossPromotionPreferences.

Parameters:
showCrossPromotionPreferences - Boolean

getShowDispatchCutoffTimePreferences

public java.lang.Boolean getShowDispatchCutoffTimePreferences()
Gets the GetUserPreferencesRequestType.showDispatchCutoffTimePreferences.

Returns:
Boolean

setShowDispatchCutoffTimePreferences

public void setShowDispatchCutoffTimePreferences(java.lang.Boolean showDispatchCutoffTimePreferences)
Sets the GetUserPreferencesRequestType.showDispatchCutoffTimePreferences.

Parameters:
showDispatchCutoffTimePreferences - Boolean

getShowEmailShipmentTrackingNumberPreference

public java.lang.Boolean getShowEmailShipmentTrackingNumberPreference()
Gets the GetUserPreferencesRequestType.showEmailShipmentTrackingNumberPreference.

Returns:
Boolean

setShowEmailShipmentTrackingNumberPreference

public void setShowEmailShipmentTrackingNumberPreference(java.lang.Boolean showEmailShipmentTrackingNumberPreference)
Sets the GetUserPreferencesRequestType.showEmailShipmentTrackingNumberPreference.

Parameters:
showEmailShipmentTrackingNumberPreference - Boolean

getShowEndOfAuctionEmailPreferences

public java.lang.Boolean getShowEndOfAuctionEmailPreferences()
Gets the GetUserPreferencesRequestType.showEndOfAuctionEmailPreferences.

Returns:
Boolean

setShowEndOfAuctionEmailPreferences

public void setShowEndOfAuctionEmailPreferences(java.lang.Boolean showEndOfAuctionEmailPreferences)
Sets the GetUserPreferencesRequestType.showEndOfAuctionEmailPreferences.

Parameters:
showEndOfAuctionEmailPreferences - Boolean

getShowGlobalShippingProgramListingPreference

public java.lang.Boolean getShowGlobalShippingProgramListingPreference()
Gets the GetUserPreferencesRequestType.showGlobalShippingProgramListingPreference.

Returns:
Boolean

setShowGlobalShippingProgramListingPreference

public void setShowGlobalShippingProgramListingPreference(java.lang.Boolean showGlobalShippingProgramListingPreference)
Sets the GetUserPreferencesRequestType.showGlobalShippingProgramListingPreference.

Parameters:
showGlobalShippingProgramListingPreference - Boolean

getShowGlobalShippingProgramPreference

public java.lang.Boolean getShowGlobalShippingProgramPreference()
Gets the GetUserPreferencesRequestType.showGlobalShippingProgramPreference.

Returns:
Boolean

setShowGlobalShippingProgramPreference

public void setShowGlobalShippingProgramPreference(java.lang.Boolean showGlobalShippingProgramPreference)
Sets the GetUserPreferencesRequestType.showGlobalShippingProgramPreference.

Parameters:
showGlobalShippingProgramPreference - Boolean

getShowOutOfStockControlPreference

public java.lang.Boolean getShowOutOfStockControlPreference()
Gets the GetUserPreferencesRequestType.showOutOfStockControlPreference.

Returns:
Boolean

setShowOutOfStockControlPreference

public void setShowOutOfStockControlPreference(java.lang.Boolean showOutOfStockControlPreference)
Sets the GetUserPreferencesRequestType.showOutOfStockControlPreference.

Parameters:
showOutOfStockControlPreference - Boolean

getShowOverrideGSPServiceWithIntlServicePreference

public java.lang.Boolean getShowOverrideGSPServiceWithIntlServicePreference()
Gets the GetUserPreferencesRequestType.showOverrideGSPServiceWithIntlServicePreference.

Returns:
Boolean

setShowOverrideGSPServiceWithIntlServicePreference

public void setShowOverrideGSPServiceWithIntlServicePreference(java.lang.Boolean showOverrideGSPServiceWithIntlServicePreference)
Sets the GetUserPreferencesRequestType.showOverrideGSPServiceWithIntlServicePreference.

Parameters:
showOverrideGSPServiceWithIntlServicePreference - Boolean

getShowPickupDropoffPreferences

public java.lang.Boolean getShowPickupDropoffPreferences()
Gets the GetUserPreferencesRequestType.showPickupDropoffPreferences.

Returns:
Boolean

setShowPickupDropoffPreferences

public void setShowPickupDropoffPreferences(java.lang.Boolean showPickupDropoffPreferences)
Sets the GetUserPreferencesRequestType.showPickupDropoffPreferences.

Parameters:
showPickupDropoffPreferences - Boolean

getShowProStoresPreferences

public java.lang.Boolean getShowProStoresPreferences()
Gets the GetUserPreferencesRequestType.showProStoresPreferences.

Returns:
Boolean

setShowProStoresPreferences

public void setShowProStoresPreferences(java.lang.Boolean showProStoresPreferences)
Sets the GetUserPreferencesRequestType.showProStoresPreferences.

Parameters:
showProStoresPreferences - Boolean

getShowPurchaseReminderEmailPreferences

public java.lang.Boolean getShowPurchaseReminderEmailPreferences()
Gets the GetUserPreferencesRequestType.showPurchaseReminderEmailPreferences.

Returns:
Boolean

setShowPurchaseReminderEmailPreferences

public void setShowPurchaseReminderEmailPreferences(java.lang.Boolean showPurchaseReminderEmailPreferences)
Sets the GetUserPreferencesRequestType.showPurchaseReminderEmailPreferences.

Parameters:
showPurchaseReminderEmailPreferences - Boolean

getShowRequiredShipPhoneNumberPreference

public java.lang.Boolean getShowRequiredShipPhoneNumberPreference()
Gets the GetUserPreferencesRequestType.showRequiredShipPhoneNumberPreference.

Returns:
Boolean

setShowRequiredShipPhoneNumberPreference

public void setShowRequiredShipPhoneNumberPreference(java.lang.Boolean showRequiredShipPhoneNumberPreference)
Sets the GetUserPreferencesRequestType.showRequiredShipPhoneNumberPreference.

Parameters:
showRequiredShipPhoneNumberPreference - Boolean

getShowSellerExcludeShipToLocationPreference

public java.lang.Boolean getShowSellerExcludeShipToLocationPreference()
Gets the GetUserPreferencesRequestType.showSellerExcludeShipToLocationPreference.

Returns:
Boolean

setShowSellerExcludeShipToLocationPreference

public void setShowSellerExcludeShipToLocationPreference(java.lang.Boolean showSellerExcludeShipToLocationPreference)
Sets the GetUserPreferencesRequestType.showSellerExcludeShipToLocationPreference.

Parameters:
showSellerExcludeShipToLocationPreference - Boolean

getShowSellerFavoriteItemPreferences

public java.lang.Boolean getShowSellerFavoriteItemPreferences()
Gets the GetUserPreferencesRequestType.showSellerFavoriteItemPreferences.

Returns:
Boolean

setShowSellerFavoriteItemPreferences

public void setShowSellerFavoriteItemPreferences(java.lang.Boolean showSellerFavoriteItemPreferences)
Sets the GetUserPreferencesRequestType.showSellerFavoriteItemPreferences.

Parameters:
showSellerFavoriteItemPreferences - Boolean

getShowSellerPaymentPreferences

public java.lang.Boolean getShowSellerPaymentPreferences()
Gets the GetUserPreferencesRequestType.showSellerPaymentPreferences.

Returns:
Boolean

setShowSellerPaymentPreferences

public void setShowSellerPaymentPreferences(java.lang.Boolean showSellerPaymentPreferences)
Sets the GetUserPreferencesRequestType.showSellerPaymentPreferences.

Parameters:
showSellerPaymentPreferences - Boolean

getShowSellerProfilePreferences

public java.lang.Boolean getShowSellerProfilePreferences()
Gets the GetUserPreferencesRequestType.showSellerProfilePreferences.

Returns:
Boolean

setShowSellerProfilePreferences

public void setShowSellerProfilePreferences(java.lang.Boolean showSellerProfilePreferences)
Sets the GetUserPreferencesRequestType.showSellerProfilePreferences.

Parameters:
showSellerProfilePreferences - Boolean

getShowSellerReturnPreferences

public java.lang.Boolean getShowSellerReturnPreferences()
Gets the GetUserPreferencesRequestType.showSellerReturnPreferences.

Returns:
Boolean

setShowSellerReturnPreferences

public void setShowSellerReturnPreferences(java.lang.Boolean showSellerReturnPreferences)
Sets the GetUserPreferencesRequestType.showSellerReturnPreferences.

Parameters:
showSellerReturnPreferences - Boolean

getShowUnpaidItemAssistanceExclusionList

public java.lang.Boolean getShowUnpaidItemAssistanceExclusionList()
Gets the GetUserPreferencesRequestType.showUnpaidItemAssistanceExclusionList.

Returns:
Boolean

setShowUnpaidItemAssistanceExclusionList

public void setShowUnpaidItemAssistanceExclusionList(java.lang.Boolean showUnpaidItemAssistanceExclusionList)
Sets the GetUserPreferencesRequestType.showUnpaidItemAssistanceExclusionList.

Parameters:
showUnpaidItemAssistanceExclusionList - Boolean

getShowUnpaidItemAssistancePreference

public java.lang.Boolean getShowUnpaidItemAssistancePreference()
Gets the GetUserPreferencesRequestType.showUnpaidItemAssistancePreference.

Returns:
Boolean

setShowUnpaidItemAssistancePreference

public void setShowUnpaidItemAssistancePreference(java.lang.Boolean showUnpaidItemAssistancePreference)
Sets the GetUserPreferencesRequestType.showUnpaidItemAssistancePreference.

Parameters:
showUnpaidItemAssistancePreference - Boolean

getShoweBayPLUSPreference

public java.lang.Boolean getShoweBayPLUSPreference()
Gets the GetUserPreferencesRequestType.showeBayPLUSPreference.

Returns:
Boolean

setShoweBayPLUSPreference

public void setShoweBayPLUSPreference(java.lang.Boolean showeBayPLUSPreference)
Sets the GetUserPreferencesRequestType.showeBayPLUSPreference.

Parameters:
showeBayPLUSPreference - Boolean

getReturnedBidderNoticePreferences

public BidderNoticePreferencesType getReturnedBidderNoticePreferences()
Valid after executing the API. Gets the returned GetUserPreferencesResponseType.returnedBidderNoticePreferences.

Returns:
BidderNoticePreferencesType

getReturnedCombinedPaymentPreferences

public CombinedPaymentPreferencesType getReturnedCombinedPaymentPreferences()
Valid after executing the API. Gets the returned GetUserPreferencesResponseType.returnedCombinedPaymentPreferences.

Returns:
CombinedPaymentPreferencesType

getReturnedCrossPromotionPreferences

public CrossPromotionPreferencesType getReturnedCrossPromotionPreferences()
Valid after executing the API. Gets the returned GetUserPreferencesResponseType.returnedCrossPromotionPreferences.

Returns:
CrossPromotionPreferencesType

getReturnedDispatchCutoffTimePreference

public DispatchCutoffTimePreferencesType getReturnedDispatchCutoffTimePreference()
Valid after executing the API. Gets the returned GetUserPreferencesResponseType.returnedDispatchCutoffTimePreference.

Returns:
DispatchCutoffTimePreferencesType

getReturnedEBayPLUSPreference

public EBayPLUSPreferenceType[] getReturnedEBayPLUSPreference()
Valid after executing the API. Gets the returned GetUserPreferencesResponseType.returnedEBayPLUSPreference.

Returns:
EBayPLUSPreferenceType[]

getReturnedEmailShipmentTrackingNumberPreference

public java.lang.Boolean getReturnedEmailShipmentTrackingNumberPreference()
Valid after executing the API. Gets the returned GetUserPreferencesResponseType.returnedEmailShipmentTrackingNumberPreference.

Returns:
Boolean

getReturnedEndOfAuctionEmailPreferences

public EndOfAuctionEmailPreferencesType getReturnedEndOfAuctionEmailPreferences()
Valid after executing the API. Gets the returned GetUserPreferencesResponseType.returnedEndOfAuctionEmailPreferences.

Returns:
EndOfAuctionEmailPreferencesType

getReturnedGlobalShippingProgramListingPreference

public java.lang.Boolean getReturnedGlobalShippingProgramListingPreference()
Valid after executing the API. Gets the returned GetUserPreferencesResponseType.returnedGlobalShippingProgramListingPreference.

Returns:
Boolean

getReturnedOfferGlobalShippingProgramPreference

public java.lang.Boolean getReturnedOfferGlobalShippingProgramPreference()
Valid after executing the API. Gets the returned GetUserPreferencesResponseType.returnedOfferGlobalShippingProgramPreference.

Returns:
Boolean

getReturnedOutOfStockControlPreference

public java.lang.Boolean getReturnedOutOfStockControlPreference()
Valid after executing the API. Gets the returned GetUserPreferencesResponseType.returnedOutOfStockControlPreference.

Returns:
Boolean

getReturnedOverrideGSPServiceWithIntlServicePreference

public java.lang.Boolean getReturnedOverrideGSPServiceWithIntlServicePreference()
Valid after executing the API. Gets the returned GetUserPreferencesResponseType.returnedOverrideGSPServiceWithIntlServicePreference.

Returns:
Boolean

getReturnedPickupDropoffSellerPreference

public java.lang.Boolean getReturnedPickupDropoffSellerPreference()
Valid after executing the API. Gets the returned GetUserPreferencesResponseType.returnedPickupDropoffSellerPreference.

Returns:
Boolean

getReturnedProStoresPreference

public ProStoresCheckoutPreferenceType getReturnedProStoresPreference()
Valid after executing the API. Gets the returned GetUserPreferencesResponseType.returnedProStoresPreference.

Returns:
ProStoresCheckoutPreferenceType

getReturnedPurchaseReminderEmailPreferences

public PurchaseReminderEmailPreferencesType getReturnedPurchaseReminderEmailPreferences()
Valid after executing the API. Gets the returned GetUserPreferencesResponseType.returnedPurchaseReminderEmailPreferences.

Returns:
PurchaseReminderEmailPreferencesType

getReturnedRequiredShipPhoneNumberPreference

public java.lang.Boolean getReturnedRequiredShipPhoneNumberPreference()
Valid after executing the API. Gets the returned GetUserPreferencesResponseType.returnedRequiredShipPhoneNumberPreference.

Returns:
Boolean

getReturnedSellerExcludeShipToLocationPreferences

public SellerExcludeShipToLocationPreferencesType getReturnedSellerExcludeShipToLocationPreferences()
Valid after executing the API. Gets the returned GetUserPreferencesResponseType.returnedSellerExcludeShipToLocationPreferences.

Returns:
SellerExcludeShipToLocationPreferencesType

getReturnedSellerFavoriteItemPreferences

public SellerFavoriteItemPreferencesType getReturnedSellerFavoriteItemPreferences()
Valid after executing the API. Gets the returned GetUserPreferencesResponseType.returnedSellerFavoriteItemPreferences.

Returns:
SellerFavoriteItemPreferencesType

getReturnedSellerPaymentPreferences

public SellerPaymentPreferencesType getReturnedSellerPaymentPreferences()
Valid after executing the API. Gets the returned GetUserPreferencesResponseType.returnedSellerPaymentPreferences.

Returns:
SellerPaymentPreferencesType

getReturnedSellerProfilePreferences

public SellerProfilePreferencesType getReturnedSellerProfilePreferences()
Valid after executing the API. Gets the returned GetUserPreferencesResponseType.returnedSellerProfilePreferences.

Returns:
SellerProfilePreferencesType

getReturnedSellerReturnPreferences

public SellerReturnPreferencesType getReturnedSellerReturnPreferences()
Valid after executing the API. Gets the returned GetUserPreferencesResponseType.returnedSellerReturnPreferences.

Returns:
SellerReturnPreferencesType

getReturnedSellerThirdPartyCheckoutDisabled

public java.lang.Boolean getReturnedSellerThirdPartyCheckoutDisabled()
Valid after executing the API. Gets the returned GetUserPreferencesResponseType.returnedSellerThirdPartyCheckoutDisabled.

Returns:
Boolean

getReturnedUnpaidItemAssistancePreferences

public UnpaidItemAssistancePreferencesType getReturnedUnpaidItemAssistancePreferences()
Valid after executing the API. Gets the returned GetUserPreferencesResponseType.returnedUnpaidItemAssistancePreferences.

Returns:
UnpaidItemAssistancePreferencesType

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.