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 Shipping preferences > Offer combined payments and shipping on My eBay, it could take up to 7 days for eBay to apply the updated 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 User preferences.

See also the reference documentation for this call:

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

Input

See also Samples.

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 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>
  <DispatchCutoffTimePreference> DispatchCutoffTimePreferencesType
    <CutoffTime> time </CutoffTime>
  </DispatchCutoffTimePreference>
  <EmailShipmentTrackingNumberPreference> boolean </EmailShipmentTrackingNumberPreference>
  <EndOfAuctionEmailPreferences> EndOfAuctionEmailPreferencesType
    <EmailCustomized> boolean </EmailCustomized>
    <LogoCustomized> boolean </LogoCustomized>
    <LogoType> EndOfAuctionLogoTypeCodeType </LogoType>
    <LogoURL> anyURI </LogoURL>
    <TemplateText> string </TemplateText>
    <TextCustomized> boolean </TextCustomized>
  </EndOfAuctionEmailPreferences>
  <GlobalShippingProgramListingPreference> boolean </GlobalShippingProgramListingPreference>
  <OutOfStockControlPreference> boolean </OutOfStockControlPreference>
  <OverrideGSPserviceWithIntlService> boolean </OverrideGSPserviceWithIntlService>
  <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 (token) </DisplayPayNowButton>
    <FedExRateOption> FedExRateOptionCodeType </FedExRateOption>
    <PayPalAlwaysOn> boolean </PayPalAlwaysOn>
    <PayPalPreferred> boolean </PayPalPreferred>
    <SellerPaymentAddress> AddressType
      <Country> CountryCodeType </Country>
    </SellerPaymentAddress>
    <UPSRateOption> UPSRateOptionCodeType </UPSRateOption>
    <USPSRateOption> USPSRateOptionCodeType </USPSRateOption>
  </SellerPaymentPreferences>
  <UnpaidItemAssistancePreferences> UnpaidItemAssistancePreferencesType
    <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	This container is included if the seller wishes to receive contact information for unsuccessful bidders. This preference is only applicable for auction listings.
BidderNoticePreferences .UnsuccessfulBidderNoticeIncludeMyItems	boolean	Conditional	This boolean field should be set to true in a SetUserPreferences call if the seller wishes to receive contact information for bidders who have bid on a seller's auction item, but did not win. This might be helpful to a seller if that seller wishes to proposed Second Chance Offers to these unsuccessful bidders if the seller has multiple, identical items, or if the winning bidder does not pay for the original auction item. This field is always returned with BidderNoticePreferences container in the GetUserPreferences response.
CombinedPaymentPreferences	CombinedPaymentPreferencesType	Optional	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.
CombinedPaymentPreferences .CombinedPaymentOption	CombinedPaymentOptionCodeType	Optional	Specifies whether or not a seller wants to allow buyers to combine single order line items into a Combined Invoice order. A Combined Invoice 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 Invoice 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 Invoice 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 Invoice 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 Invoice order and make one payment for that order. SpecifyDiscountLater (in/out) This value indicates that the seller allows Combined Invoice orders, and that the seller will apply any shipping discounts after the creation of the Combined Invoice order. See Combined Invoice.
DispatchCutoffTimePreference	DispatchCutoffTimePreferencesType	Optional	This container is included if the seller wishes to set/modify 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: For sellers opted in to the feature that supports different order cut off times for each business day, this container cannot be used to change the order cut off for one or more business days. If this container is used, it will have no effect on any of the order cut off times configured for the seller. In order for the seller to change and/or confirm the actual order cutoff times for same-day handling, that seller should go to Shipping Preferences in My eBay. See Same day handling 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: For sellers opted in to the feature that supports different order cutoff times for each business day, the order cutoff time is not applicable. This cutoff time cannot be changed with the SetUserPreferences call, and the value returned in the GetUserPreferences call may not be accurate if the seller has customized this cutoff time for one or more business days. In order for the seller to change and/or confirm the actual order cutoff times for same-day handling, that seller should go to Shipping Preferences in My eBay. 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 Same day handling for details about dispatch cut off times.
EmailShipmentTrackingNumberPreference	boolean	Optional	This field is included and set to `true` if the seller wishes to email the shipment's tracking number to the buyer. Default: false.
EndOfAuctionEmailPreferences	EndOfAuctionEmailPreferencesType	Optional	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.
EndOfAuctionEmailPreferences .EmailCustomized	boolean	Optional	This field is used in a SetUserPreferences call to set/change the setting of whether a customized email will be sent to the winning bidder or not. This field is always returned to indicate whether or not a customized email will be sent to the winning bidder.
EndOfAuctionEmailPreferences .LogoCustomized	boolean	Optional	This field is used in a SetUserPreferences call to set/change the setting of whether a customized logo will be used or not in the customized email that is sent to the winning bidder. The URI to a customized logo is provided through the TemplateText field. If the seller would like to use a customized logo, the LogoType field must also be included, and its value will be set to `Customized`. This field is always returned to indicate whether or not a customized logo is used in a customized email that is sent to the winning bidder.
EndOfAuctionEmailPreferences .LogoType	EndOfAuctionLogoTypeCodeType	Conditional	This field is needed in the SetUserPreferences call if the seller would like to use a customized or eBay Store logo. If the seller would like to use a customized logo, this field's value will be set to `Customized`. If the seller would like to use their eBay Store logo (if it exists), this field's value will be set to `Store`. This field is always returned, and its value will be `None` if no logo is used in the customized email. Applicable values: CustomCode (in/out) Reserved for internal or future use. Customized (in/out) This enumeration value indicates that a custom logo will be used in the end of auction email to winning bidder. The location (URL) of this custom logo can be given through the LogoURL field of the SetUserPreferences call. Just like any URL that is provided through eBay API calls, the URL for the custom logo must use 'https' (and not 'http'). Store (in/out) This enumeration value indicates that the eBay seller's Store logo will be used in the end of auction email to winning bidder. WinningBidderNotice (in/out) This enumeration value indicates that the Winning Bidder Notice logo will be used in the end of auction email to winning bidder. (Not all values in EndOfAuctionLogoTypeCodeType apply to this field.)
EndOfAuctionEmailPreferences .LogoURL	anyURI	Optional	The seller can include a customized logo in the email that is sent to the winner of an auction listing. The full URI to this logo image should be applied in this field. If the seller is going to include a customized logo in the email through this field, the seller must also include the LogoCustomized field and set its value to `true`, and include the LogoType field and set its value to `Customized`. This field is only returned if a customized logo is being used for the customized email.
EndOfAuctionEmailPreferences .TemplateText	string	Optional	The seller can customize the text of the email that is sent to the winner of an auction listing. The text of the email is provided in this field. If the seller is going to customize the text of the email through this field, the seller must also include the TextCustomized field and set its value to `true`.The text of the custom message for the email. This field is only returned if set for the account. Max length: 3948.
EndOfAuctionEmailPreferences .TextCustomized	boolean	Optional	This field is used in a SetUserPreferences call to set/change the setting of whether customized text will be used or not in the customized email that is sent to the winning bidder. Customized text is provided through the LogoURL field. This field is always returned to indicate whether or not customized text is used in a customized email that is sent to the winning bidder.
GlobalShippingProgramListingPreference	boolean	Optional	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`). Default: false.
OutOfStockControlPreference	boolean	Optional	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. Default: false. See Out-of-Stock control.
OverrideGSPserviceWithIntlService	boolean	Optional	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. Default: false.
PurchaseReminderEmailPreferences	PurchaseReminderEmailPreferencesType	Optional	This container is included if the seller wishes to set the 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	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. Default: false.
SellerFavoriteItemPreferences	SellerFavoriteItemPreferencesType	Optional	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.
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) This enumeration value is only applicable to the GetMyeBaySelling call. This value is used in the ActiveList.ListingType field if the seller only wants to retrieve active listings that are in the auction format. FixedPriceItem (in/out) With this listing format, the selling is offering the item at a fixed price, although it is still possible for the seller to negotiate the price with prospective buyers using the Best Offer feature. A fixed-price listing can offer a single item, or if the seller has multiple quantity of the same item, multiple quantity of that same item can be made available for sale through the same listing. Additionally, the seller can set up a multiple-variation, fixed-price listing, where similar items can be sold through the same listing. An example of a multiple-variation, fixed-price listing might be a t-shirt (or another article of clothing) that is available in multiple color and size combinations. Traditionally, listing durations for fixed-prices listings have varied by eBay marketplace and category. Typical listing durations for fixed-price listings ranged from three to 30 days, or GTC (Good 'Til Cancelled). As of April 1, 2019, 'GTC' is the only supported listing duration for all eBay marketplaces with the following exceptions: The following eBay Motors US categories are exempt from this change: Cars & Trucks (6001), Motorcycles (6024), Other Vehicles & Trailers (6038), Boats (26429), Powersports (66466). All child categories under Cars, Motorcycles & Vehicles (9800) categories on the eBay UK and eBay Italy sites are also exempt from this change. With the 'GTC' listing duration, the listing will remain active as long as the listing shows that inventory is available for purchase (available quantity is '1' or more). For sellers listing motor vehicles on the eBay US Motors, eBay UK, or eBay Italy sites, it is recommended that the seller uses the GetCategoryFeatures call to retrieve the supported listing durations for their particular marketplace and category. Note: As long as a fixed-price listing has inventory available, or if the out-of-stock control feature is being used, GTC listings are automatically renewed each month according to the calendar day. LeadGeneration (in/out) This enumeration value represents a (non-Real Estate) classified ad listing. The `AdType` enumeration value represents Real Estate classified ads. This listing type is only used to solicit inquiries from interested parties. To express interest, a buyer fills in a contact form that eBay forwards to the seller as a lead. This format does not enable buyers and sellers to transact online through eBay, and eBay Feedback is not available for ad format listings. Non-Real Estate classified ads are only available in a limited number of eBay categories, including Business and Industrial categories, Travel, ans Specialty Services. Although listing durations may vary by eBay marketplace and category, typical listing durations for (non-Real Estate) classified ads are 30, 60, and 90 days. It is recommended that the seller uses the GetCategoryFeatures call to retrieve the actual listing durations that are supported for real estate ads on a particular marketplace and category. (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: See SearchSortOrder.
SellerFavoriteItemPreferences .StoreCategoryID	long	Optional	(For eBay Store owners only) The store custom category for the automatic item search criteria.
SellerPaymentPreferences	SellerPaymentPreferencesType	Optional	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.
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 listing'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	This field is deprecated. If it is used in a SetUserPreferences call, it is ignored.
SellerPaymentPreferences .DisplayPayNowButton	DisplayPayNowButtonCodeType (token)	Optional	This field is deprecated. If it is used in a SetUserPreferences call, it is ignored.
SellerPaymentPreferences .FedExRateOption	FedExRateOptionCodeType	Optional	This enumeration value indicates the category/level of Federal Express shipping rates that are available to the seller. Applicable values: CustomCode (in/out) Reserved for internal or future use FedExCounter (in/out) This enumeration value indicates that the seller offers buyers Federal Express counter rates. FedExDiscounted (in/out) This enumeration value indicates that the seller offers buyers discounted Federal Express shipping rates. Buyers will get these discounted shipping rates as long as they use the eBay-generated shipping labels. FedExStandardList (in/out) This enumeration value indicates that the seller offers buyers the standard Federal Express shipping rates.
SellerPaymentPreferences .PayPalAlwaysOn	boolean	Optional	This field is deprecated. If it is used in a SetUserPreferences call, it is ignored.
SellerPaymentPreferences .PayPalPreferred	boolean	Optional	This field is deprecated. If it is used in a SetUserPreferences call, it is ignored.
SellerPaymentPreferences .SellerPaymentAddress	AddressType	Optional	This container consists of the seller's mailing address where the buyer will send payment for an order. A seller's payment address only comes into play if the listing'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 .SellerPaymentAddress.Country	CountryCodeType	Optional	The two-digit code representing the country of the user. If not provided as input, eBay uses the country associated with the eBay Site ID when the call is made. Applicable values: See Country.
SellerPaymentPreferences .UPSRateOption	UPSRateOptionCodeType	Optional	This enumeration value indicates the category/level of UPS shipping rates that are available to the seller. Applicable values: CustomCode (in/out) Reserved for internal or future use UPSDailyRates (in/out) This enumeration value indicates that the seller is currently receiving the UPS Daily Rate for shipping items. UPSOnDemandRates (in/out) This enumeration value indicates that the seller is currently receiving the UPS On-Demand Rate for shipping items.
SellerPaymentPreferences .USPSRateOption	USPSRateOptionCodeType	Optional	This enumeration value indicates the category/level of US Postal Service shipping rates that are available to the seller. Applicable values: CustomCode (in/out) Reserved for internal or future use USPSDiscounted (in/out) This enumeration value indicates that the seller is currently receiving the USPS Discounted Rate for shipping items. USPSRetail (in/out) This enumeration value indicates that the seller is currently receiving the USPS Retail Rate for shipping items.
UnpaidItemAssistancePreferences	UnpaidItemAssistancePreferencesType	Optional	This container is included if the seller wishes to set or modify Unpaid Item preferences. The Unpaid Item preferences 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. See: Unpaid Item Assistant Understanding the New Unpaid Item Process
UnpaidItemAssistancePreferences .AutoRelist	boolean	Optional	Flag to indicate whether or not the seller wants eBay to automatically relist items after an unpaid order is cancelled. For a multiple-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 preferences feature on My eBay.
UnpaidItemAssistancePreferences .DelayBeforeOpeningDispute	int	Optional	This value indicates the number of days that should elapse before an unpaid order is cancelled on behalf of the seller. Valid values are: 4, 7, 11, 19, 27, and 30 (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 preferences feature on My eBay. Min: 4. Max: 30.
UnpaidItemAssistancePreferences .ExcludedUser	string	Optional, repeatable: [0..*]	An eBay User ID to which the seller's Unpaid Item preferences do not apply. A seller may want to create an excluded user list if that seller prefers to work directly with those buyers to work out the unpaid order situation. One or more ExcludedUser fields are used in SetUserPreferences to add users to Unpaid Item preferences 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 preferences feature in Unpaid Item 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 seller has enabled Unpaid Item preferences. Unpaid Item preferences must be enabled for any of the Unpaid Item preferences to have an effect.
UnpaidItemAssistancePreferences .RemoveAllExcludedUsers	boolean	Optional	This field should be included and set to `true` if the seller wants to clear all excluded users set in Unpaid Item preferences. A seller may want to create an excluded user list if that seller prefers to work directly with those buyers to work out the unpaid order situation. 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 preferences feature in Unpaid Item 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. Below are some examples from different countries.

ID	Country
en_AU	Australia
de_AT	Austria
nl_BE	Belgium (Dutch)
fr_BE	Belgium (French)
en_CA	Canada
fr_CA	Canada (French)
zh_CN	China
fr_FR	France
de_DE	Germany
zh_HK	Hong Kong
en_IN	India
en_IE	Ireland
it_IT	Italy
nl_NL	Netherlands
en_SG	Singapore
es_ES	Spain
de_CH	Switzerland
en_GB	United Kingdom
en_US	United States

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., 1149). 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:
    HTTP headers
    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 performed in the Production environment.

Applicable values:

High

(in) The WarningLevel value is set to High if the user wishes to receive warnings when the application passes unrecognized or deprecated elements in an API call request. Setting the WarningLevel value to High is not recommended in a production environment. Instead, it should only be used during the development/debugging stage.

Low

(in) The WarningLevel value is set to Low if the user does not wish to receive warnings when the application passes unrecognized or deprecated elements in an API call request. This is the default value if WarningLevel is not specified in the call request.

See Warning Level.

Output

Detail Controls

DetailLevel

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

Samples

New to making API calls? Please see Making a Call.

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

A seller wants to update a few account-level selling preferences.

Description

A seller wants to update the following settings: 1: Use eBay Global Shipping Program for international orders by default 2: Enable Out-of-Stock control for all fixed-price listings.

Input

To turn on Global Shipping Program by default for all listings that support international shipping, the seller includes the GlobalShippingProgramListingPreference boolean field and sets its value to true.

To enable Out-of-Stock control for all fixed-price listings, the seller includes the OutOfStockControlPreference boolean field and sets its value to true.

XML format.

<?xml version="1.0" encoding="utf-8"?> 
<SetUserPreferencesRequest xmlns="urn:ebay:apis:eBLBaseComponents"> 
  <RequesterCredentials>
    <eBayAuthToken>A*******3</eBayAuthToken>
  </RequesterCredentials>
  <WarningLevel>High</WarningLevel> 
  <GlobalShippingProgramListingPreference>true</GlobalShippingProgramListingPreference>
  <OutOfStockControlPreference>true</OutOfStockControlPreference>
</SetUserPreferencesRequest>

Output

An Ack value of Success in the response indicates that the SetUserPreferencesRequest action(s) were successful.

XML format.
<SetUserPreferencesResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2019-11-07T18:43:26.541Z</Timestamp>
  <Ack>Success</Ack>
  <Version>1131</Version>
  <Build>E1131_CORE_APISELLING_19099826_R1</Build>
</SetUserPreferencesResponse>

Change History

Change Date	Description
849 2013-11-05	OverrideGSPserviceWithIntlService (added): Set this boolean field to true for a given seller, and the seller can offer an international shipping service to a particular country for a Global Shipping-eligible listing. The seller-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.
829 2013-06-19	GlobalShippingProgramListingPreference (added): Set this boolean field to true for a given seller, and the seller's new listings will enable the Global Shipping Program by default.
825 2013-05-22	SellerPaymentPreferences.FedExRateOption (modified): A new enumeration value, FedExDiscounted, can be specified in FedExRateOption, indicating that the FedEx Discounted shipping rate scale is being selected for the user.
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.

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 the Ack field. Applicable values: CustomCode (out) Reserved for internal or future use. Failure (out) This value indicates that the call request processing failed. Success (out) This value indicates that the call request was processed successfully without any issues. Warning (out) This value indicates that the call request was successful, but processing was not without any issues. These issues can be checked in the Errors container, that will also be returned when one or more known issues occur with the call request. (Not all values in AckCodeType apply to this field.) Code so that your app gracefully handles any future changes to this list.
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.
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. Code so that your app gracefully handles any future changes to this list.
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 Errors By Number.
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	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.Value	string	Conditionally	This is the value of the request parameter noted in the ParamID attribute. So, if the ParamID value was ItemID, the value in this field would be the actual value of that ItemID.
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) The request that triggered the error was not processed successfully. When a serious application-level error occurs, the error is returned instead of the business data. If the source of the problem is within the application (such as a missing required element), change the application before you retry the request. If the problem is due to end-user input data, please alert the end-user to the problem and provide the means for them to correct the data. Once the problem in the application or data is resolved, you can attempt to re-send the request to eBay. If the source of the problem is on eBay's side, 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. See the Error handling section of the Making a Trading API call guide for more information. Warning (out) The request was processed successfully, but something occurred that may affect your application or the user. For example, eBay may have changed a value the user sent in. In this case, eBay returns a normal, successful response and also returns the warning. When a warning occurs, the error is returned in addition to the business data. In this case, you do not need to retry the request (as the original request was successful). However, depending on the cause or nature of the warning, you might need to contact either the end user or eBay to effect a long term solution to the problem to prevent it from reoccurring in the future. Code so that your app gracefully handles any future changes to this list.
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 the Time Values section in the eBay Features 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 the Standard Data for All Calls section in the eBay Features Guide for information on using the response version when troubleshooting CustomCode values that appear in the response.