SetUserPreferences

Use this call to set the authenticated user's preferences to those specified in the request.

SetUserPreferences takes as input the data for the user preferences you want to set. If the call is successful, it returns only the standard data indicating that the call succeeded. If unsuccessful, it returns an error construct (see Error Handling).

As a general rule, once you set a preference, a call to GetUserPreferences (and the user's preferences displayed on the eBay Web site) should reflect the new setting immediately. However, it could take up to 7 days for the change to have any logical or functional effect. For example, if you change your combined payment preferences, it could take up to 7 days for eBay to apply the updated combined payment settings to your listings. Also, once you set a preference, you cannot change its setting again within 7 days.

You can test this call in the Sandbox. Before calling SetUserPreferences, create one or more test users in the Sandbox. Then define user preferences for the test user using a call to SetUserPreferences. You can verify that the preferences were set correctly by retrieving the preferences for that user with a call to GetUserPreferences.

See Managing User Preferences.

See also the reference documentation for this call:

GetUserPreferences - Retrieves the specified user preferences for the authenticated caller.

SetUserPreferences Input

The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also Samples.

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are (or soon will be) non-operational.

The XML prototype does not include requester credentials. This is a documentation limitation only (see Standard Requester Credentials for Making Calls).

<?xml version="1.0" encoding="utf-8"?>
<SetUserPreferencesRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Input Fields -->
  <BidderNoticePreferences> BidderNoticePreferencesType
    <UnsuccessfulBidderNoticeIncludeMyItems> boolean </UnsuccessfulBidderNoticeIncludeMyItems>
  </BidderNoticePreferences>
  <CombinedPaymentPreferences> CombinedPaymentPreferencesType
    <CombinedPaymentOption> CombinedPaymentOptionCodeType </CombinedPaymentOption>
  </CombinedPaymentPreferences>
  <CrossPromotionPreferences> CrossPromotionPreferencesType
    <CrossPromotionEnabled> boolean </CrossPromotionEnabled>
    <CrossSellGallerySortFilter> GallerySortFilterCodeType </CrossSellGallerySortFilter>
    <CrossSellItemFormatSortFilter> ItemFormatSortFilterCodeType </CrossSellItemFormatSortFilter>
    <CrossSellItemSortFilter> ItemSortFilterCodeType </CrossSellItemSortFilter>
    <UpSellGallerySortFilter> GallerySortFilterCodeType </UpSellGallerySortFilter>
    <UpSellItemFormatSortFilter> ItemFormatSortFilterCodeType </UpSellItemFormatSortFilter>
    <UpSellItemSortFilter> ItemSortFilterCodeType </UpSellItemSortFilter>
  </CrossPromotionPreferences>
  <DispatchCutoffTimePreference> DispatchCutoffTimePreferencesType
    <CutoffTime> time </CutoffTime>
  </DispatchCutoffTimePreference>
  <EmailShipmentTrackingNumberPreference> boolean </EmailShipmentTrackingNumberPreference>
  <EndOfAuctionEmailPreferences> EndOfAuctionEmailPreferencesType
    <CopyEmail> boolean </CopyEmail>
    <EmailCustomized> boolean </EmailCustomized>
    <LogoCustomized> boolean </LogoCustomized>
    <LogoType> EndOfAuctionLogoTypeCodeType </LogoType>
    <LogoURL> anyURI </LogoURL>
    <TemplateText> string </TemplateText>
    <TextCustomized> boolean </TextCustomized>
  </EndOfAuctionEmailPreferences>
  <PurchaseReminderEmailPreferences> PurchaseReminderEmailPreferencesType
    <PurchaseReminderEmailPreferences> boolean </PurchaseReminderEmailPreferences>
  </PurchaseReminderEmailPreferences>
  <RequiredShipPhoneNumberPreference> boolean </RequiredShipPhoneNumberPreference>
  <SellerFavoriteItemPreferences> SellerFavoriteItemPreferencesType
    <FavoriteItemID> ItemIDType (string) </FavoriteItemID>
    <!-- ... more FavoriteItemID values allowed here ... -->
    <ListingType> ListingTypeCodeType </ListingType>
    <MaxPrice> AmountType (double) </MaxPrice>
    <MinPrice> AmountType (double) </MinPrice>
    <SearchKeywords> string </SearchKeywords>
    <SearchSortOrder> StoreItemListSortOrderCodeType </SearchSortOrder>
    <StoreCategoryID> long </StoreCategoryID>
  </SellerFavoriteItemPreferences>
  <SellerPaymentPreferences> SellerPaymentPreferencesType
    <AlwaysUseThisPaymentAddress> boolean </AlwaysUseThisPaymentAddress>
    <DefaultPayPalEmailAddress> string </DefaultPayPalEmailAddress>
    <DisplayPayNowButton> DisplayPayNowButtonCodeType </DisplayPayNowButton>
    <FedExRateOption> FedExRateOptionCodeType </FedExRateOption>
    <PayPalAlwaysOn> boolean </PayPalAlwaysOn>
    <PayPalPreferred> boolean </PayPalPreferred>
    <SellerPaymentAddress> AddressType
      <Country> CountryCodeType </Country>
    </SellerPaymentAddress>
    <UPSRateOption> UPSRateOptionCodeType </UPSRateOption>
    <USPSRateOption> USPSRateOptionCodeType </USPSRateOption>
  </SellerPaymentPreferences>
  <SellerThirdPartyCheckoutDisabled> boolean </SellerThirdPartyCheckoutDisabled>
  <UnpaidItemAssistancePreferences> UnpaidItemAssistancePreferencesType
    <AutoOptDonationRefund> boolean </AutoOptDonationRefund>
    <AutoRelist> boolean </AutoRelist>
    <DelayBeforeOpeningDispute> int </DelayBeforeOpeningDispute>
    <ExcludedUser> string </ExcludedUser>
    <!-- ... more ExcludedUser values allowed here ... -->
    <OptInStatus> boolean </OptInStatus>
    <RemoveAllExcludedUsers> boolean </RemoveAllExcludedUsers>
  </UnpaidItemAssistancePreferences>
  <!-- Standard Input Fields -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
</SetUserPreferencesRequest>

Argument	Type	Occurrence	Meaning

Call-specific Input Fields [Jump to standard fields]

BidderNoticePreferences	BidderNoticePreferencesType	Optional	Container consisting of the seller's preference for receiving contact information for unsuccessful bidders. This preference is only applicable for auction listings.
BidderNoticePreferences .UnsuccessfulBidderNoticeIncludeMyItems	boolean	Optional	If true, sends the seller a notice containing the contact information for unsuccessful bidders.
CombinedPaymentPreferences	CombinedPaymentPreferencesType	Optional	Container consisting of the seller's preference for allowing combined payment on multiple orders shared between the same seller and buyer. Note: Calculated and flat-rate shipping preferences are no longer set using this call. Instead, use the SetShippingDiscountProfiles call to set the shipping discounts for combined payment orders. Note: A seller's combined payment preferences can take up to 7 days to have any logical or functional effect on eBay.
CombinedPaymentPreferences .CombinedPaymentOption	CombinedPaymentOptionCodeType	Optional	Specifies whether or not a seller wants to allow buyers to combine single order line items into a Combined Payment order. A Combined Payment order can be created by the buyer or seller if multiple unpaid order line items exist between the same buyer and seller. Often, a Combined Payment order can reduce shipping and handling expenses for the buyer and seller. Applicable values: • CustomCode (in/out) Reserved for internal or future use. • DiscountSpecified (in/out) This value indicates that the seller allows Combined Payment orders, and that the seller has one or more shipping discount rules (Flat, Calculated, or Promotional) that can be applied at the listing level. • NoCombinedPayment (in/out) This value indicates that the seller does not allow Combined Payment orders. In other words, the buyer must pay for each order line item separately, and cannot combine multiple single line item orders into one Combined Payment order and make one payment for that order. • SpecifyDiscountLater (in/out) This value indicates that the seller allows Combined Payment orders, and that the seller will apply any shipping discounts after the creation of the Combined Payment order.
CrossPromotionPreferences	CrossPromotionPreferencesType	Optional	This container should no longer be used as eBay Store Cross Promotions are no longer supported in the Trading API. This container will be removed from the Trading WSDL and API Call Reference docs in a future release. Container consisting of the seller's cross-promotion preferences. These preferences are only applicable for eBay Store owners. One or more preferences may be set or modified under this field.
CrossPromotionPreferences .CrossPromotionEnabled	boolean	Optional	(For eBay store owners only) Specifies whether cross-promotions are enabled for the seller's listings. Note: This field should no longer be used as eBay Store Cross Promotions are no longer supported in the Trading API.
CrossPromotionPreferences .CrossSellGallerySortFilter	GallerySortFilterCodeType	Optional	(For eBay store owners only) Specifies whether to display only items with gallery images and whether they should precede other items in cross-sell promotions. Note: This field should no longer be used as eBay Store Cross Promotions are no longer supported in the Trading API. Applicable values: • CustomCode (in/out) Reserved for internal or future use. • ShowAnyItems (in/out) Show any items, in no particular order. • ShowItemsWithGalleryImagesFirst (in/out) Show items with gallery images first, before other items. • ShowOnlyItemsWithGalleryImages (in/out) Show only items with gallery images.
CrossPromotionPreferences .CrossSellItemFormatSortFilter	ItemFormatSortFilterCodeType	Optional	(For eBay store owners only) Specifies which items should be shown in cross-sell promotions (such as Buy It Now or Store Inventory items) and in which sequence. Note: This field should no longer be used as eBay Store Cross Promotions are no longer supported in the Trading API. Applicable values: • CustomCode (in/out) Reserved for internal or future use. • ShowAnyItems (in/out) Show any items, in no particular order. • ShowItemsWithBINFirst (in/out) Show items with a Buy It Now price first. • ShowOnlyItemsWithBIN (in/out) Show only items with a Buy It Now price. • ShowOnlyStoreItems (in/out) Show only store inventory items.
CrossPromotionPreferences .CrossSellItemSortFilter	ItemSortFilterCodeType	Optional	(For eBay store owners only) Specifies how to sort items displayed in a cross-sell promotion. Note: This field should no longer be used as eBay Store Cross Promotions are no longer supported in the Trading API. Applicable values: • CustomCode (in/out) Reserved for internal or future use. • EndingLast (in/out) Sort items by ending time, with items ending last first. • EndingSoonest (in/out) Sort items by ending time, with items ending soonest first. • HighestPrice (in/out) Sort items by price, with the highest price first. • LowestPrice (in/out) Sort items by price, with the lowest price first. • NewlyListed (in/out) Sort items by listing time, with newly listed items first. • RandomlySelected (in/out) Sort items in a randomly selected order.
CrossPromotionPreferences .UpSellGallerySortFilter	GallerySortFilterCodeType	Optional	(For eBay store owners only) Specifies whether to display only items with gallery images in upsell promotions and whether they should precede other items. Note: This field should no longer be used as eBay Store Cross Promotions are no longer supported in the Trading API. Applicable values: • CustomCode (in/out) Reserved for internal or future use. • ShowAnyItems (in/out) Show any items, in no particular order. • ShowItemsWithGalleryImagesFirst (in/out) Show items with gallery images first, before other items. • ShowOnlyItemsWithGalleryImages (in/out) Show only items with gallery images.
CrossPromotionPreferences .UpSellItemFormatSortFilter	ItemFormatSortFilterCodeType	Optional	(For eBay store owners only) Specifies which items (such as Buy It Now or Store Inventory items) should be shown in upsell promotions and in which sequence. Note: This field should no longer be used as eBay Store Cross Promotions are no longer supported in the Trading API. Applicable values: • CustomCode (in/out) Reserved for internal or future use. • ShowAnyItems (in/out) Show any items, in no particular order. • ShowItemsWithBINFirst (in/out) Show items with a Buy It Now price first. • ShowOnlyItemsWithBIN (in/out) Show only items with a Buy It Now price. • ShowOnlyStoreItems (in/out) Show only store inventory items.
CrossPromotionPreferences .UpSellItemSortFilter	ItemSortFilterCodeType	Optional	(For eBay store owners only) Specifies how to sort items used in an upsell promotion. Note: This field should no longer be used as eBay Store Cross Promotions are no longer supported in the Trading API. Applicable values: • CustomCode (in/out) Reserved for internal or future use. • EndingLast (in/out) Sort items by ending time, with items ending last first. • EndingSoonest (in/out) Sort items by ending time, with items ending soonest first. • HighestPrice (in/out) Sort items by price, with the highest price first. • LowestPrice (in/out) Sort items by price, with the lowest price first. • NewlyListed (in/out) Sort items by listing time, with newly listed items first. • RandomlySelected (in/out) Sort items in a randomly selected order.
DispatchCutoffTimePreference	DispatchCutoffTimePreferencesType	Optional	Contains information about a seller's order cut off 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 cut off time set for the listing site, as indicated by DispatchCutoffTimePreference.CutoffTime. See Specifying Shipping Services for details about dispatch cut off times.
DispatchCutoffTimePreference .CutoffTime	time	Conditional	If the seller specifies a DispatchTimeMax value of `0` to indicate same day handling for an item, the seller's shipping commitment depends on the value of CutoffTime for the eBay site on which the item is listed. For orders placed (and cleared payment received) before the indicated cut off time, the item must be shipped by the end of the current day. For orders completed on or after the cut off time, the item must be shipped by the end of the following day (excluding weekends and local holidays). Note: If a same day shipping carrier is selected, and the carrier delivers on one or both weekend days, sellers on the eBay US site are assumed to be open for business on the same days, and those days will be used when calculating total shipping time. CutoffTime has a default initial value for each eBay site, but you can use SetUserPreferences to override the default for individual sellers. The default value for most eBay sites is 2:00PM local time. Enter times in 30 minute increments from the top of the hour. That is, enter values either on the hour (:00) or 30 minutes past the hour (:30). Other values will be rounded down to the next closest 30 minute increment. Times entered should be local to the value provided for TimeZoneID. See Specifying Shipping Services for details about dispatch cut off times.
EmailShipmentTrackingNumberPreference	boolean	Optional	Flag that controls whether the shipment's tracking number is sent by Email from the seller to the buyer. Default: false.
EndOfAuctionEmailPreferences	EndOfAuctionEmailPreferencesType	Optional	Container consisting of the seller's 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 field. These preferences are only applicable for auction listings.
EndOfAuctionEmailPreferences .CopyEmail	boolean	Optional	Indicates whether or not the seller wishes to receive a copy of the customized email sent to the winning buyer.
EndOfAuctionEmailPreferences .EmailCustomized	boolean	Optional	Indicates whether or not the seller wishes to send a customized email to winning buyers.
EndOfAuctionEmailPreferences .LogoCustomized	boolean	Optional	Indicates whether or not the seller wishes to include a logo in the customized email.
EndOfAuctionEmailPreferences .LogoType	EndOfAuctionLogoTypeCodeType	Optional	The type of logo to include in the customized email. Applicable values: • CustomCode (in/out) Reserved for internal or future use. • Customized (in/out) A custom logo specified in LogoURL. • Store (in/out) The seller's eBay Store logo. • WinningBidderNotice (in/out) The PayPal Winning Bidder Notice logo. (Not all values in EndOfAuctionLogoTypeCodeType apply to this field.)
EndOfAuctionEmailPreferences .LogoURL	anyURI	Optional	The URL of the logo to include in the customized email.
EndOfAuctionEmailPreferences .TemplateText	string	Optional	The text of the custom message for the email.
EndOfAuctionEmailPreferences .TextCustomized	boolean	Optional	Indicates whether or not the text of the customized message will be customized.
PurchaseReminderEmailPreferences	PurchaseReminderEmailPreferencesType	Optional	Container consisting of a seller's preference for sending a purchase reminder email to buyers.
PurchaseReminderEmailPreferences .PurchaseReminderEmailPreferences	boolean	Optional	If true, a payment reminder Email is sent to buyers.
RequiredShipPhoneNumberPreference	boolean	Optional	Flag that controls whether the buyer is required to provide a shipping phone number upon checkout. Some shipping carriers require the receiver's phone number. Default: false.
SellerFavoriteItemPreferences	SellerFavoriteItemPreferencesType	Optional	Container consisting of the seller's 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 field.
SellerFavoriteItemPreferences .FavoriteItemID	ItemIDType (string)	Optional, repeatable: [0..*]	Specifies the list of favorite items.
SellerFavoriteItemPreferences .ListingType	ListingTypeCodeType	Optional	The listing format (fixed price, auction, etc) for the automatic item search criteria. Applicable values: • Auction (in/out) An optional input parameter used with GetMyeBaySelling. When used in the request, returns items of competitive-bid auctions. • FixedPriceItem (in/out) A basic fixed-price item format. Bids do not occur. The quantity of items is one or more. Also known as Buy It Now Only on some sites (not to be confused with the BuyItNow option that is available for auctions). Sellers must meet certain feedback requirements and/or be ID Verified to use this format. See Minimum Feedback Requirements for Various Features in the Trading Web Services guide. Fixed-price listings are listed on eBay.com, and they are listed in the seller's eBay Store if the seller is a Store owner. Stores fixed price items will be treated as basic fixed-price items. Permitted durations of 30 days and GTC are now available for store and non-store subscribers (in addition to the existing durations of 3, 5, 7, and 10 days). • LeadGeneration (in/out) Lead Generation format (advertisement-style listing to solicit inquiries or offers, no bidding or fixed price, listed on eBay). (Not all values in ListingTypeCodeType apply to this field.)
SellerFavoriteItemPreferences .MaxPrice	AmountType (double)	Optional	Specifies the upper limit of price range for the automatic search criteria.
SellerFavoriteItemPreferences .MinPrice	AmountType (double)	Optional	Specifies the lower limit of price range for the automatic search criteria.
SellerFavoriteItemPreferences .SearchKeywords	string	Optional	The keywords in the item title for the automatic item search criteria.
SellerFavoriteItemPreferences .SearchSortOrder	StoreItemListSortOrderCodeType	Optional	The sort order chosen from the standard ebay sorts for the automatic search criteria. Applicable values: • CustomCode (in/out) Reserved for internal or future use. • EndingFirst (in/out) Lists items with those ending soon listed first. • HighestPriced (in/out) Lists items by price in descending order. The item with the highest starting price is listed first. • HighestPricedPlusShipping (in/out) Reserved for future use. Lists items by combined price and shipping cost in descending order. The item with the highest combined starting price plus shipping cost is listed first. • LowestPriced (in/out) Lists items by price in ascending order. The item with the lowest starting price is listed first. • LowestPricedPlusShipping (in/out) Lists items by combined price and shipping cost in ascending order. The item with the lowest combined starting price plus shipping cost is listed first. • NewlyListed (in/out) Lists items with those newly listed appearing in the list first.
SellerFavoriteItemPreferences .StoreCategoryID	long	Optional	(For eBay Store owners only) The store custom category for the automatic item search criteria.
SellerPaymentPreferences	SellerPaymentPreferencesType	Optional	Container consisting of the seller's payment preferences. One or more preferences may be set or modified under this field. Payment preferences specified in a SetUserPreferences call override the settings in My eBay payment preferences.
SellerPaymentPreferences .AlwaysUseThisPaymentAddress	boolean	Optional	Sellers include this field and set it to 'true' if they want buyers to mail payment to the payment address specified in the SellerPaymentPreferences.SellerPaymentAddress field. A payment address only comes into play if the item's category allows offline payments, and the seller has allowed the buyer to mail a payment. This payment address will only be displayed to winning bidders and buyers.
SellerPaymentPreferences .DefaultPayPalEmailAddress	string	Optional	Specifies the default email address the seller uses for receiving PayPal payments.
SellerPaymentPreferences .DisplayPayNowButton	DisplayPayNowButtonCodeType	Optional	If set, this field determines whether a Pay Now button is displayed for all of the user's listings. The user has the option of using a PayPal only version of the Pay Now button or a Pay Now button for all payment methods. Applicable values: • CustomCode (in/out) Reserved for internal or future use • ShowPayNowButtonForAllPaymentMethods (in/out) Show PayNow Button For All Payment Methods • ShowPayNowButtonForPayPalOnly (in/out) Show PayNow Button For PayPal Only
SellerPaymentPreferences .FedExRateOption	FedExRateOptionCodeType	Optional	Specifies the type of FedEx rates to use. Applicable values: • CustomCode (in/out) Reserved for internal or future use • FedExCounter (in/out) FedEx Counter Rates • FedExStandardList (in/out) FedEx Standard List Rates
SellerPaymentPreferences .PayPalAlwaysOn	boolean	Optional	Indicates whether PayPal is always accepted for the seller's listings.
SellerPaymentPreferences .PayPalPreferred	boolean	Optional	Specifies whether a seller wants to let buyers know that PayPal payments are preferred.
SellerPaymentPreferences .SellerPaymentAddress	AddressType	Optional	Specifies the address the seller uses to receive mailed payments from buyers.
SellerPaymentPreferences .SellerPaymentAddress.Country	CountryCodeType	Optional	The two-digit code representing the country of the user. If not provided as input for GetCart or SetCart, eBay uses the country associated with the SiteID in effect when the call is made. For a Global Shipping Program order, GetSellerList returns the country code of the buyer, not the international shipping provider. Also applicable to Half.com (for GetOrders). Applicable values: See Country.
SellerPaymentPreferences .UPSRateOption	UPSRateOptionCodeType	Optional	Specifies the type of United Parcel Service rates to use. Applicable values: • CustomCode (in/out) Reserved for internal or future use • UPSDailyRates (in/out) UPS Daily Rates • UPSOnDemandRates (in/out) UPS On-Demand Rates
SellerPaymentPreferences .USPSRateOption	USPSRateOptionCodeType	Optional	Specifies the type of USPS rates to use. Applicable values: • CustomCode (in/out) Reserved for internal or future use • USPSDiscounted (in/out) USPS Discounted • USPSRetail (in/out) USPS Retail
SellerThirdPartyCheckoutDisabled	boolean	Optional	A flag used to disable the use of a third-party application to handle the checkout flow for a seller. If set to true, Third-Party Checkout is disabled and any checkout flow initiated on the seller's application is redirected to the eBay checkout flow. Default: false.
UnpaidItemAssistancePreferences	UnpaidItemAssistancePreferencesType	Optional	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. One or more preferences may be set or modified under this field. See: Unpaid Item Assistant Understanding the New Unpaid Item Process
UnpaidItemAssistancePreferences .AutoOptDonationRefund	boolean	Optional	Flag to indicate whether or not the seller wants eBay to automatically request eBay Giving Works donation refunds after Unpaid Item cases are opened and closed through the Unpaid Item Assistant mechanism without payment. This setting is only applicable to eBay Charity listings. This field is ignored if the OptInStatus flag is included and set to false in the request, or if the seller is not currently opted into the Unpaid Item Assistant feature in Unpaid Item Assistant Preferences on My eBay.
UnpaidItemAssistancePreferences .AutoRelist	boolean	Optional	Flag to indicate whether or not the seller wants eBay to automatically relist items after corresponding Unpaid Item cases are opened and closed through the Unpaid Item Assistant mechanism without payment. For a multi-quantity listing, the quantity is adjusted if AutoRelist is set to true. This field is ignored if the OptInStatus flag is included and set to false in the request, or if the seller is not currently opted into the Unpaid Item Assistant feature in Unpaid Item Assistant Preferences on My eBay.
UnpaidItemAssistancePreferences .DelayBeforeOpeningDispute	int	Optional	This value indicates the number of days that should elapse before the Unpaid Item Assistant mechanism opens an Unpaid Item case on behalf of the seller. Valid values for this field are: 2, 4, 8, 16, 24, and 32 (days). This field is ignored if the OptInStatus flag is included and set to false in the request, or if the seller is not currently opted into the Unpaid Item Assistant feature in Unpaid Item Assistant Preferences on My eBay. Min: 2. Max: 32. Default: 32.
UnpaidItemAssistancePreferences .ExcludedUser	string	Optional, repeatable: [0..*]	An eBay User ID for which the Unpaid Item Assistant mechanism is disabled. This field is typically used by a seller who would prefer to file an Unpaid Item dispute manually for the specified user. One or more ExcludedUser fields are used in SetUserPreferences to add users to Unpaid Item Assistant Exclusion list. Any and all ExcludedUser fields are ignored if the OptInStatus flag is included and set to false in the request, or if the seller is not currently opted into the Unpaid Item Assistant feature in Unpaid Item Assistant Preferences on My eBay. In GetUserPreferences, one or more ExcludedUser fields represent the current Excluded user list.
UnpaidItemAssistancePreferences .OptInStatus	boolean	Optional	Flag to indicate whether or not the Unpaid Item Assistant mechanism is turned on for the seller. Through the Unpaid Item Assistant mechanism, eBay can automatically file Unpaid Item cases on behalf of the seller. The Unpaid Item Assistant feature also has options to automatically relist disputed items, to automatically request a Giving Works donation refund (for Charity listings only), or to create an 'Exclusion list' of buyers who are not subject to the automatic filing of an Unpaid Item case.
UnpaidItemAssistancePreferences .RemoveAllExcludedUsers	boolean	Optional	This field should be included and set to true if the seller wants to clear all users from the Unpaid Item Assistant Exclusion list. The Exclusion list can be viewed from the Unpaid Item Assistant Preferences in My eBay. Excluded users are not subject to the automatic filing of Unpaid Item cases. The seller can still open Unpaid Item cases against excluded users, but these cases must be opened manually. Users can be added to Exclusion list through the ExcludedUser field. The RemoveAllExcludedUsers field is ignored if the OptInStatus flag is included and set to false in the request, or if the seller is not currently opted into the Unpaid Item Assistant feature in Unpaid Item Assistant Preferences on My eBay.

Standard Input Fields

ErrorLanguage	string	Optional	Use ErrorLanguage to return error strings for the call in a different language from the language commonly associated with the site that the requesting user is registered with. Specify the standard RFC 3066 language identification tag (e.g., en_US). ID--- country ----- ----- de_AT Austria de_CH Switzerland de_DE Germany en_AU Australia en_CA Canada en_GB United Kingdom en_SG Singapore en_US United States es_ES Spain fr_BE Belgium (French) fr_CA Canada (French) fr_FR France it_IT Italy nl_BE Belgium (Dutch) nl_NL Netherlands zh_CN China en_IN India en_IE Ireland zh_HK Hong Kong See Tags for the Identification of Languages.
MessageID	string	Optional	Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned. Note: GetCategories is designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
Version	string	Conditional	The version number of the API code that you are programming against (e.g., 549). The version you specify for a call has these basic effects: - It indicates the version of the code lists and other data that eBay should use to process your request. - It indicates the schema version you are using. You need to use a version that is greater than or equal to the lowest supported version. For the SOAP API: If you are using the SOAP API, this field is required. Specify the version of the WSDL your application is using. For the XML API: If you are using the XML API, this field has no effect. Instead, specify the version in the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header. (If you specify Version in the body of an XML API request and it is different from the value in the HTTP header, eBay returns an informational warning that the value in the HTTP header was used instead.) See: Routing the Request (Gateway URLs) eBay Schema Versioning Strategy Lowest Supported Version
WarningLevel	WarningLevelCodeType	Optional	Controls whether or not to return warnings when the application passes unrecognized or deprecated elements in a request. An unrecognized element is one that is not defined in any supported version of the schema. Schema element names are case-sensitive, so using WarningLevel can also help you remove any potential hidden bugs within your application due to incorrect case or spelling in field names before you put your application into the Production environment. WarningLevel only validates elements; it doesn't validate XML attributes. It also doesn't control warnings related to user-entered strings or numbers, or warnings for logical errors. We recommend that you only use this during development and debugging. Do not use this in requests in your production code. Applicable values: • High (in) Return warnings when the application passes unrecognized or deprecated elements in a request. • Low (in) Do not return warnings when the application passes unrecognized or deprecated elements in a request. This is the default value if WarningLevel is not specified. See Warning Level.

SetUserPreferences Output

The box below lists all fields that might be returned in the response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

SetUserPreferences Detail Controls

Detail Control: DetailLevel

This call does not support varying Detail Levels. You do not need to pass DetailLevel in the request.

SetUserPreferences Samples

New to making API calls? Please see Routing the Request.

Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.

Sample: Basic Call

Set the user preferences to those indicated in the request.

Description

Magical Bookseller wants to update various Seller Payment preferences, particularly those associated with her PayPal settings.

Input

XML format (HTTP POST). Also available is the .txt version of this XML.

<?xml version="1.0" encoding="utf-8"?> 
<SetUserPreferencesRequest xmlns="urn:ebay:apis:eBLBaseComponents"> 
  <RequesterCredentials>
    <eBayAuthToken>ABC...123</eBayAuthToken>
  </RequesterCredentials>
  <WarningLevel>High</WarningLevel> 
  <SellerPaymentPreferences>
    <DefaultPayPalEmailAddress>2065 Hamilton Ave, San Jose, CA  95125</DefaultPayPalEmailAddress>
    <PayPalAlwaysOn>true</PayPalAlwaysOn>
    <PayPalPreferred>true</PayPalPreferred>
  </SellerPaymentPreferences>
</SetUserPreferencesRequest>

Output

XML format. Also available is the .txt version of this XML.

<SetUserPreferencesResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2010-01-20T21:28:46.959Z</Timestamp>
  <Ack>Success</Ack>
  <Version>643</Version>
  <Build>E643_CORE_BUNDLED_10284414_R1</Build>
</SetUserPreferencesResponse>

SetUserPreferences Change History

Version	Description
817 2013-03-27	DispatchCutoffTimePreference.CutOffTime (added): If the seller specifies a DispatchTimeMax value of 0 to indicate same day handling for an item, the seller's shipping commitment depends on the value of CutOffTime for the eBay site on which the item is listed. For orders placed (and cleared payment received) before the specified cut off time, the item must be shipped by the end of the current day. For orders completed on or after the cut off time, the item must be shipped by the end of the following day (excluding weekends and local holidays).
797 2012-10-24	CrossPromotionPreferences (modified): This container should no longer be used as eBay Store Cross Promotions are no longer supported in the Trading API. This container will be removed from the Trading WSDL and API Call Reference docs in a future release.
745 2011-10-26	UnpaidItemAssistancePreferences.AutoOptDonationRefund (added): This flag is used if the seller wants eBay to automatically request eBay Giving Works donation refunds after UPI cases are opened and closed through the UPI Assistant mechanism.
719 2011-04-27	SetUserPreferencesRequestType.RequiredShipPhoneNumberPreference (added): Flag used by the seller to require that buyer supply a shipping phone number.
685 2010-07-09	SellerThirdPartyCheckoutDisabled (added): This field is used by the seller to disable Third-Party Checkout. If set to true, Third-Party Checkout is disabled and any Third-Party Checkout flow that is initiated is redirected to the eBay checkout flow.
681 2010-08-04	UnpaidItemAssistancePreferences.AutoRelist (added): For sellers who have opted in to the automated Unpaid Item Assistance mechanism, AutoRelist automatically relists items that were part of disputes resolved through the UPI Assistance mechanism. UnpaidItemAssistancePreferences.ExcludedUser (added): Sellers can specify which buyers to exclude from the automated Unpaid Item Assistance mechanism. UnpaidItemAssistancePreferences.RemoveAllExcludedUsers (added): Sellers can clear all buyers from the Unpaid Item Assistance excluded user list.
673 2010-06-09	PurchaseReminderEmailPreferences.PurchaseReminderEmailPreferences (added): Sets the preference for whether a purchase reminder email is sent to buyers. Formerly, eBay sent the email by default, and the functionality could not be changed by a seller.
637 2009-09-30	UnpaidItemAssistancePreferences (added): Sellers can now set their preference for the Unpaid Item Assistance mechanism.
635 2009-09-16	InsuranceDetails, InsuranceFee, InsuranceOption, InternationalInsuranceDetails, InsuranceWanted, ShippingInsuranceCost (modified): Sellers can no longer give buyers the option to purchase shipping insurance for either domestic or international items. The buyer-paid shipping insurance option has been removed from the following sites: `BEFR, BENL, CA, CAFR, HK, IE, IN, MY, Motors, NL, PH, PL, SG, UK, US` Insurance tags are returned only when the associated item has buyer-paid shipping insurance values.
601 2009-01-21	SellerFavoriteItemPreferences.SearchSortOrder.HighestPricedPlusShipping, SellerFavoriteItemPreferences.SearchSortOrder.LowestPricedPlusShipping (added): New values enabled for buyers to specify the default order items are displayed in the favorite seller email marketing they receive.
509 2007-04-18	CombinedPaymentPreferences (modified): Modified text to mention that developers should not use this field.
499 2007-02-07	eBxOptInPreference (modified): Deleted previously deprecated object from the latest schema. See Deprecated Objects. SellerFavoriteItemPreferences.StoreCategoryID (modified): The data types for IDs used for eBay Stores have changed from xs:int to xs:long to prepare for future increases in ID values.
469 2006-07-12	DefaultPayPalAccount (added): A PayPal account (email address) to use for eBay Express payments during checkout. Express Germany users only.
463 2006-05-31	ExpressSellingPreference (added): Specifies the kinds of eligible listings the seller wants to include on eBay Express. Some values are only applicable to certain sites. Only applicable to sellers who are eligible to list on Express.

User-Contributed Notes

Ack	AckCodeType	Always	A token representing the application-level acknowledgement code that indicates the response status (e.g., success). The AckCodeType list specifies the possible values for Ack. Applicable values: • CustomCode (out) Reserved for internal or future use. • Failure (out) Request processing failed • Success (out) Request processing succeeded • Warning (out) Request processing completed with warning information being included in the response message (Not all values in AckCodeType apply to this field.)
Build	string	Always	This refers to the specific software build that eBay used when processing the request and generating the response. This includes the version number plus additional information. eBay Developer Support may request the build information when helping you resolve technical issues.
CorrelationID	string	Conditionally	Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned. Note: GetCategories is designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
Errors	ErrorType	Conditionally, repeatable: [0..*]	A list of application-level errors (if any) that occurred when eBay processed the request. See Error Handling.
Errors.ErrorClassification	ErrorClassificationCodeType	Conditionally	API errors are divided between two classes: system errors and request errors. Applicable values: • CustomCode (out) Reserved for internal or future use. • RequestError (out) An error has occurred either as a result of a problem in the sending application or because the application's end-user has attempted to submit invalid data (or missing data). In these cases, do not retry the request. The problem must be corrected before the request can be made again. If the problem is due to something in the application (such as a missing required field), the application must be changed. If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the application or data is resolved, resend the request to eBay with the corrected data. • SystemError (out) Indicates that an error has occurred on the eBay system side, such as a database or server down. An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.
Errors.ErrorCode	token	Conditionally	A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms. See the "Errors by Number" document.
Errors.ErrorParameters	ErrorParameterType	Conditionally, repeatable: [0..*]	This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned.
Errors.ErrorParameters [ attribute ParamID ]	string	Conditionally	The index of the parameter in the list of parameter types returned within the error type.
Errors.ErrorParameters.Value	string	Conditionally	The value of the variable (e.g., the attribute set ID)
Errors.LongMessage	string	Conditionally	A more detailed description of the condition that raised the error.
Errors.SeverityCode	SeverityCodeType	Conditionally	Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user. Applicable values: • CustomCode (out) Reserved for internal or future use • Error (out) Application-level error • Warning (out) Warning or informational error
Errors.ShortMessage	string	Conditionally	A brief description of the condition that raised the error.
HardExpirationWarning	string	Conditionally	Expiration date of the user's authentication token. Only returned within the 7-day period prior to a token's expiration. To ensure that user authentication tokens are secure and to help avoid a user's token being compromised, tokens have a limited life span. A token is only valid for a period of time (set by eBay). After this amount of time has passed, the token expires and must be replaced with a new token.
Timestamp	dateTime	Always	This value represents the date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See Time Values in the eBay Web Services guide for information about this time format and converting to and from the GMT time zone. Note: GetCategories and other Trading API calls are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, this time value reflects the time the cached response was created. Thus, this value is not necessarily when the request was processed. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, this time value does reflect when the request was processed.
Version	string	Always	The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. See "Standard Data for All Calls" in the eBay Web Services Guide for information on using the response version when troubleshooting "CustomCode" values that appear in the response.

eBay Trading API Call Reference Version 823