Changes since
the last release

com.ebay.sdk.call
Class SetUserPreferencesCall

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

public class SetUserPreferencesCall
extends ApiCall

Wrapper class of the SetUserPreferences 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: BidderNoticePreferences - This container is included if the seller wishes to receive contact information for unsuccessful bidders. This preference is only applicable for auction listings.
Input property: CombinedPaymentPreferences - This container is included if the seller wishes to set the preference for allowing Combined Invoice orders for cases where the buyer has multiple unpaid order line items from the same seller.
Input property: CrossPromotionPreferences - This container is deprecated.
Input property: SellerPaymentPreferences - This container is included if the seller wishes to set various payment preferences. One or more preferences may be set or modified under this container. Payment preferences specified in a SetUserPreferences call override the settings in My eBay payment preferences.
Input property: SellerFavoriteItemPreferences - This container is included if the seller wishes to set preferences for displaying items on a buyer's Favorite Sellers' Items page or Favorite Sellers' Items digest. One or more preferences may be set or modified under this container.
Input property: EndOfAuctionEmailPreferences - This container is included if the seller wishes to set preferences for the end-of-auction email sent to the winning bidder. These preferences allow the seller to customize the Email that is sent to buyer at the end of the auction. One or more preferences may be set or modified under this container. These preferences are only applicable for auction listings.
Input property: EmailShipmentTrackingNumberPreference - This field is included and set to true if the seller wishes to email the shipment's tracking number to the buyer.
Input property: RequiredShipPhoneNumberPreference - This field is included and set to true if the seller wishes to require the buyer to provide a shipping phone number upon checkout. Some shipping carriers require the receiver's phone number.
Input property: UnpaidItemAssistancePreferences - This container is included if the seller wishes to set Unpaid Item Assistant preferences. The Unpaid Item Assistant automatically opens an Unpaid Item case on the behalf of the seller if the buyer has not paid for the order after a specified number of days. One or more preferences may be set or modified under this container.
Input property: PurchaseReminderEmailPreferences - This container is included if the seller wishes to set the preference for sending a purchase reminder email to buyers.
Input property: SellerThirdPartyCheckoutDisabled - This field is no longer applicable, as third-party checkout on eBay is no longer possible.
Input property: DispatchCutoffTimePreference - This container is included if the seller wishes to set the order cut off time 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 cut off time set for the listing site, as indicated by the DispatchCutoffTimePreference.CutoffTime field.

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: GlobalShippingProgramListingPreference - If this flag is included and set to true, the seller's new listings will enable the Global Shipping Program by default.

Note: This field is ignored for sellers who are not opted in to the Global Shipping Program (when GetUserPreferences returns OfferGlobalShippingProgramPreference with a value of false).
Input property: OverrideGSPserviceWithIntlService - If this flag is included and set to true, and the seller specifies an international shipping service to a particular country for a given listing, 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. The Global Shipping Program will still be the listing's default option for shipping to any Global Shipping-eligible country for which the seller does not specify an international shipping service.

If this flag is set to false, the Global Shipping Program will be each Global Shipping-eligible listing's default option for shipping to any Global Shipping-eligible country, regardless of any international shipping service that the seller specifies for the listing.
Input property: OutOfStockControlPreference - If this flag is included and set to true, it enables the Out-of-Stock feature. A seller would use this feature to keep Fixed-Price GTC (Good 'Til Canceled) listings alive even when the "quantity available" value goes to 0 (zero). This is useful when waiting for additional stock and eliminates the need to end the listing and then recreating it when stock arrives.

While the "quantity available" value is 0, the listing would be hidden from eBay search and if that item was specifically searched for with GetItem (or related call), the element HideFromSearch would be returned as 'true' and ReasonHideFromSearch would be returned as 'OutOfStock'.

When stock is available, the seller can use the Revise calls to update the inventory of the item (through the Item.Quantity or Item.Variations.Variation.Quantity fields) and the listing would appear again.

You can return the value of this flag using the GetUserPreferences call and setting the ShowOutOfStockControlPreference field to 'true'.

IMPORTANT: When a listing using the Out-of-Stock feature has zero quantity, the seller has 90 days to add inventory without incurring a listing fee. Fees are changed at the end of each the billing cycle but are then refunded if the item is out-of-stock for an entire billing period. See Fees For a Listing With Zero Quantity for details.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
SetUserPreferencesCall()
          Constructor.
SetUserPreferencesCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 BidderNoticePreferencesType getBidderNoticePreferences()
          Gets the SetUserPreferencesRequestType.bidderNoticePreferences.
 CombinedPaymentPreferencesType getCombinedPaymentPreferences()
          Gets the SetUserPreferencesRequestType.combinedPaymentPreferences.
 CrossPromotionPreferencesType getCrossPromotionPreferences()
          Gets the SetUserPreferencesRequestType.crossPromotionPreferences.
 DispatchCutoffTimePreferencesType getDispatchCutoffTimePreference()
          Gets the SetUserPreferencesRequestType.dispatchCutoffTimePreference.
 java.lang.Boolean getEmailShipmentTrackingNumberPreference()
          Gets the SetUserPreferencesRequestType.emailShipmentTrackingNumberPreference.
 EndOfAuctionEmailPreferencesType getEndOfAuctionEmailPreferences()
          Gets the SetUserPreferencesRequestType.endOfAuctionEmailPreferences.
 java.lang.Boolean getGlobalShippingProgramListingPreference()
          Gets the SetUserPreferencesRequestType.globalShippingProgramListingPreference.
 java.lang.Boolean getOutOfStockControlPreference()
          Gets the SetUserPreferencesRequestType.outOfStockControlPreference.
 java.lang.Boolean getOverrideGSPserviceWithIntlService()
          Gets the SetUserPreferencesRequestType.overrideGSPserviceWithIntlService.
 PurchaseReminderEmailPreferencesType getPurchaseReminderEmailPreferences()
          Gets the SetUserPreferencesRequestType.purchaseReminderEmailPreferences.
 java.lang.Boolean getRequiredShipPhoneNumberPreference()
          Gets the SetUserPreferencesRequestType.requiredShipPhoneNumberPreference.
 SellerFavoriteItemPreferencesType getSellerFavoriteItemPreferences()
          Gets the SetUserPreferencesRequestType.sellerFavoriteItemPreferences.
 SellerPaymentPreferencesType getSellerPaymentPreferences()
          Gets the SetUserPreferencesRequestType.sellerPaymentPreferences.
 java.lang.Boolean getSellerThirdPartyCheckoutDisabled()
          Gets the SetUserPreferencesRequestType.sellerThirdPartyCheckoutDisabled.
 UnpaidItemAssistancePreferencesType getUnpaidItemAssistancePreferences()
          Gets the SetUserPreferencesRequestType.unpaidItemAssistancePreferences.
 void setBidderNoticePreferences(BidderNoticePreferencesType bidderNoticePreferences)
          Sets the SetUserPreferencesRequestType.bidderNoticePreferences.
 void setCombinedPaymentPreferences(CombinedPaymentPreferencesType combinedPaymentPreferences)
          Sets the SetUserPreferencesRequestType.combinedPaymentPreferences.
 void setCrossPromotionPreferences(CrossPromotionPreferencesType crossPromotionPreferences)
          Sets the SetUserPreferencesRequestType.crossPromotionPreferences.
 void setDispatchCutoffTimePreference(DispatchCutoffTimePreferencesType dispatchCutoffTimePreference)
          Sets the SetUserPreferencesRequestType.dispatchCutoffTimePreference.
 void setEmailShipmentTrackingNumberPreference(java.lang.Boolean emailShipmentTrackingNumberPreference)
          Sets the SetUserPreferencesRequestType.emailShipmentTrackingNumberPreference.
 void setEndOfAuctionEmailPreferences(EndOfAuctionEmailPreferencesType endOfAuctionEmailPreferences)
          Sets the SetUserPreferencesRequestType.endOfAuctionEmailPreferences.
 void setGlobalShippingProgramListingPreference(java.lang.Boolean globalShippingProgramListingPreference)
          Sets the SetUserPreferencesRequestType.globalShippingProgramListingPreference.
 void setOutOfStockControlPreference(java.lang.Boolean outOfStockControlPreference)
          Sets the SetUserPreferencesRequestType.outOfStockControlPreference.
 void setOverrideGSPserviceWithIntlService(java.lang.Boolean overrideGSPserviceWithIntlService)
          Sets the SetUserPreferencesRequestType.overrideGSPserviceWithIntlService.
 void setPurchaseReminderEmailPreferences(PurchaseReminderEmailPreferencesType purchaseReminderEmailPreferences)
          Sets the SetUserPreferencesRequestType.purchaseReminderEmailPreferences.
 void setRequiredShipPhoneNumberPreference(java.lang.Boolean requiredShipPhoneNumberPreference)
          Sets the SetUserPreferencesRequestType.requiredShipPhoneNumberPreference.
 void setSellerFavoriteItemPreferences(SellerFavoriteItemPreferencesType sellerFavoriteItemPreferences)
          Sets the SetUserPreferencesRequestType.sellerFavoriteItemPreferences.
 void setSellerPaymentPreferences(SellerPaymentPreferencesType sellerPaymentPreferences)
          Sets the SetUserPreferencesRequestType.sellerPaymentPreferences.
 void setSellerThirdPartyCheckoutDisabled(java.lang.Boolean sellerThirdPartyCheckoutDisabled)
          Sets the SetUserPreferencesRequestType.sellerThirdPartyCheckoutDisabled.
 void setUnpaidItemAssistancePreferences(UnpaidItemAssistancePreferencesType unpaidItemAssistancePreferences)
          Sets the SetUserPreferencesRequestType.unpaidItemAssistancePreferences.
 void setUserPreferences()
          This call allows an eBay user to set/modify numerous seller account preferences.
 
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

SetUserPreferencesCall

public SetUserPreferencesCall()
Constructor.


SetUserPreferencesCall

public SetUserPreferencesCall(ApiContext apiContext)
Constructor.

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

setUserPreferences

public void setUserPreferences()
                        throws ApiException,
                               SdkException,
                               java.lang.Exception
This call allows an eBay user to set/modify numerous seller account preferences.

Throws:
ApiException
SdkException
java.lang.Exception

getBidderNoticePreferences

public BidderNoticePreferencesType getBidderNoticePreferences()
Gets the SetUserPreferencesRequestType.bidderNoticePreferences.

Returns:
BidderNoticePreferencesType

setBidderNoticePreferences

public void setBidderNoticePreferences(BidderNoticePreferencesType bidderNoticePreferences)
Sets the SetUserPreferencesRequestType.bidderNoticePreferences.

Parameters:
bidderNoticePreferences - BidderNoticePreferencesType

getCombinedPaymentPreferences

public CombinedPaymentPreferencesType getCombinedPaymentPreferences()
Gets the SetUserPreferencesRequestType.combinedPaymentPreferences.

Returns:
CombinedPaymentPreferencesType

setCombinedPaymentPreferences

public void setCombinedPaymentPreferences(CombinedPaymentPreferencesType combinedPaymentPreferences)
Sets the SetUserPreferencesRequestType.combinedPaymentPreferences.

Parameters:
combinedPaymentPreferences - CombinedPaymentPreferencesType

getCrossPromotionPreferences

public CrossPromotionPreferencesType getCrossPromotionPreferences()
Gets the SetUserPreferencesRequestType.crossPromotionPreferences.

Returns:
CrossPromotionPreferencesType

setCrossPromotionPreferences

public void setCrossPromotionPreferences(CrossPromotionPreferencesType crossPromotionPreferences)
Sets the SetUserPreferencesRequestType.crossPromotionPreferences.

Parameters:
crossPromotionPreferences - CrossPromotionPreferencesType

getDispatchCutoffTimePreference

public DispatchCutoffTimePreferencesType getDispatchCutoffTimePreference()
Gets the SetUserPreferencesRequestType.dispatchCutoffTimePreference.

Returns:
DispatchCutoffTimePreferencesType

setDispatchCutoffTimePreference

public void setDispatchCutoffTimePreference(DispatchCutoffTimePreferencesType dispatchCutoffTimePreference)
Sets the SetUserPreferencesRequestType.dispatchCutoffTimePreference.

Parameters:
dispatchCutoffTimePreference - DispatchCutoffTimePreferencesType

getEmailShipmentTrackingNumberPreference

public java.lang.Boolean getEmailShipmentTrackingNumberPreference()
Gets the SetUserPreferencesRequestType.emailShipmentTrackingNumberPreference.

Returns:
Boolean

setEmailShipmentTrackingNumberPreference

public void setEmailShipmentTrackingNumberPreference(java.lang.Boolean emailShipmentTrackingNumberPreference)
Sets the SetUserPreferencesRequestType.emailShipmentTrackingNumberPreference.

Parameters:
emailShipmentTrackingNumberPreference - Boolean

getEndOfAuctionEmailPreferences

public EndOfAuctionEmailPreferencesType getEndOfAuctionEmailPreferences()
Gets the SetUserPreferencesRequestType.endOfAuctionEmailPreferences.

Returns:
EndOfAuctionEmailPreferencesType

setEndOfAuctionEmailPreferences

public void setEndOfAuctionEmailPreferences(EndOfAuctionEmailPreferencesType endOfAuctionEmailPreferences)
Sets the SetUserPreferencesRequestType.endOfAuctionEmailPreferences.

Parameters:
endOfAuctionEmailPreferences - EndOfAuctionEmailPreferencesType

getGlobalShippingProgramListingPreference

public java.lang.Boolean getGlobalShippingProgramListingPreference()
Gets the SetUserPreferencesRequestType.globalShippingProgramListingPreference.

Returns:
Boolean

setGlobalShippingProgramListingPreference

public void setGlobalShippingProgramListingPreference(java.lang.Boolean globalShippingProgramListingPreference)
Sets the SetUserPreferencesRequestType.globalShippingProgramListingPreference.

Parameters:
globalShippingProgramListingPreference - Boolean

getOutOfStockControlPreference

public java.lang.Boolean getOutOfStockControlPreference()
Gets the SetUserPreferencesRequestType.outOfStockControlPreference.

Returns:
Boolean

setOutOfStockControlPreference

public void setOutOfStockControlPreference(java.lang.Boolean outOfStockControlPreference)
Sets the SetUserPreferencesRequestType.outOfStockControlPreference.

Parameters:
outOfStockControlPreference - Boolean

getOverrideGSPserviceWithIntlService

public java.lang.Boolean getOverrideGSPserviceWithIntlService()
Gets the SetUserPreferencesRequestType.overrideGSPserviceWithIntlService.

Returns:
Boolean

setOverrideGSPserviceWithIntlService

public void setOverrideGSPserviceWithIntlService(java.lang.Boolean overrideGSPserviceWithIntlService)
Sets the SetUserPreferencesRequestType.overrideGSPserviceWithIntlService.

Parameters:
overrideGSPserviceWithIntlService - Boolean

getPurchaseReminderEmailPreferences

public PurchaseReminderEmailPreferencesType getPurchaseReminderEmailPreferences()
Gets the SetUserPreferencesRequestType.purchaseReminderEmailPreferences.

Returns:
PurchaseReminderEmailPreferencesType

setPurchaseReminderEmailPreferences

public void setPurchaseReminderEmailPreferences(PurchaseReminderEmailPreferencesType purchaseReminderEmailPreferences)
Sets the SetUserPreferencesRequestType.purchaseReminderEmailPreferences.

Parameters:
purchaseReminderEmailPreferences - PurchaseReminderEmailPreferencesType

getRequiredShipPhoneNumberPreference

public java.lang.Boolean getRequiredShipPhoneNumberPreference()
Gets the SetUserPreferencesRequestType.requiredShipPhoneNumberPreference.

Returns:
Boolean

setRequiredShipPhoneNumberPreference

public void setRequiredShipPhoneNumberPreference(java.lang.Boolean requiredShipPhoneNumberPreference)
Sets the SetUserPreferencesRequestType.requiredShipPhoneNumberPreference.

Parameters:
requiredShipPhoneNumberPreference - Boolean

getSellerFavoriteItemPreferences

public SellerFavoriteItemPreferencesType getSellerFavoriteItemPreferences()
Gets the SetUserPreferencesRequestType.sellerFavoriteItemPreferences.

Returns:
SellerFavoriteItemPreferencesType

setSellerFavoriteItemPreferences

public void setSellerFavoriteItemPreferences(SellerFavoriteItemPreferencesType sellerFavoriteItemPreferences)
Sets the SetUserPreferencesRequestType.sellerFavoriteItemPreferences.

Parameters:
sellerFavoriteItemPreferences - SellerFavoriteItemPreferencesType

getSellerPaymentPreferences

public SellerPaymentPreferencesType getSellerPaymentPreferences()
Gets the SetUserPreferencesRequestType.sellerPaymentPreferences.

Returns:
SellerPaymentPreferencesType

setSellerPaymentPreferences

public void setSellerPaymentPreferences(SellerPaymentPreferencesType sellerPaymentPreferences)
Sets the SetUserPreferencesRequestType.sellerPaymentPreferences.

Parameters:
sellerPaymentPreferences - SellerPaymentPreferencesType

getSellerThirdPartyCheckoutDisabled

public java.lang.Boolean getSellerThirdPartyCheckoutDisabled()
Gets the SetUserPreferencesRequestType.sellerThirdPartyCheckoutDisabled.

Returns:
Boolean

setSellerThirdPartyCheckoutDisabled

public void setSellerThirdPartyCheckoutDisabled(java.lang.Boolean sellerThirdPartyCheckoutDisabled)
Sets the SetUserPreferencesRequestType.sellerThirdPartyCheckoutDisabled.

Parameters:
sellerThirdPartyCheckoutDisabled - Boolean

getUnpaidItemAssistancePreferences

public UnpaidItemAssistancePreferencesType getUnpaidItemAssistancePreferences()
Gets the SetUserPreferencesRequestType.unpaidItemAssistancePreferences.

Returns:
UnpaidItemAssistancePreferencesType

setUnpaidItemAssistancePreferences

public void setUnpaidItemAssistancePreferences(UnpaidItemAssistancePreferencesType unpaidItemAssistancePreferences)
Sets the SetUserPreferencesRequestType.unpaidItemAssistancePreferences.

Parameters:
unpaidItemAssistancePreferences - 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.