GetUserPreferences

Use this call to retrieve user preferences for the authenticated caller.

Usage Details

For a preference set to be returned, the preference set boolean field must be included in the request and set to True. So, the set of user preferences retrieved depends on the set of flags specified in the request. Specify only the flags you need to minimize the amount of data you retrieve.

All user preferences that can be returned in GetUserPreferences can be set with SetUserPreferences and many of them can be set in the My eBay page.

Inspect the properties of the returned containers to get the preference data for the authenticated user. As applicable, store the data (perhaps in a table), or display it to the user so that they can verify their current preferences.

Testing GetUserPreferences

You can test this call in the Sandbox. Before calling GetUserPreferences, create a test user in the Sandbox, then define user preferences for the user by either calling SetUserPreferences or by editing the preferences in the My eBay page for the user in the Sandbox. After setting the preferences, retrieve them with a call to GetUserPreferences, and verify that they match what you had set previously.

Related Information

See User preferences.

See also the reference documentation for this call:

SetUserPreferences - This call allows an eBay user to set/modify numerous seller account preferences.

Input

Output

See also Samples.

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).

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

<?xml version="1.0" encoding="utf-8"?>
<GetUserPreferencesResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Output Fields -->
  <BidderNoticePreferences> BidderNoticePreferencesType
    <UnsuccessfulBidderNoticeIncludeMyItems> boolean </UnsuccessfulBidderNoticeIncludeMyItems>
  </BidderNoticePreferences>
  <CombinedPaymentPreferences> CombinedPaymentPreferencesType
    <CombinedPaymentOption> CombinedPaymentOptionCodeType </CombinedPaymentOption>
  </CombinedPaymentPreferences>
  <DispatchCutoffTimePreference> DispatchCutoffTimePreferencesType
    <CutoffTime> time </CutoffTime>
  </DispatchCutoffTimePreference>
  <eBayPLUSPreference> EBayPLUSPreferenceType
    <Country> CountryCodeType </Country>
    <ListingPreference> boolean </ListingPreference>
    <OptInStatus> boolean </OptInStatus>
  </eBayPLUSPreference>
  <!-- ... more eBayPLUSPreference nodes allowed here ... -->
  <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>
  <OfferGlobalShippingProgramPreference> boolean </OfferGlobalShippingProgramPreference>
  <OutOfStockControlPreference> boolean </OutOfStockControlPreference>
  <OverrideGSPServiceWithIntlServicePreference> boolean </OverrideGSPServiceWithIntlServicePreference>
  <PickupDropoffSellerPreference> boolean </PickupDropoffSellerPreference>
  <PurchaseReminderEmailPreferences> PurchaseReminderEmailPreferencesType
    <PurchaseReminderEmailPreferences> boolean </PurchaseReminderEmailPreferences>
  </PurchaseReminderEmailPreferences>
  <RequiredShipPhoneNumberPreference> boolean </RequiredShipPhoneNumberPreference>
  <SellerExcludeShipToLocationPreferences> SellerExcludeShipToLocationPreferencesType
    <ExcludeShipToLocation> string </ExcludeShipToLocation>
    <!-- ... more ExcludeShipToLocation values allowed here ... -->
  </SellerExcludeShipToLocationPreferences>
  <SellerFavoriteItemPreferences> SellerFavoriteItemPreferencesType
    <FavoriteItemID> ItemIDType (string) </FavoriteItemID>
    <!-- ... more FavoriteItemID values allowed here ... -->
    <ListingType> ListingTypeCodeType </ListingType>
    <MaxPrice currencyID="CurrencyCodeType"> AmountType (double) </MaxPrice>
    <MinPrice currencyID="CurrencyCodeType"> 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>
  <SellerProfilePreferences> SellerProfilePreferencesType
    <SellerProfileOptedIn> boolean </SellerProfileOptedIn>
    <SupportedSellerProfiles> SupportedSellerProfilesType
      <SupportedSellerProfile> SupportedSellerProfileType
        <CategoryGroup> CategoryGroupType
          <IsDefault> boolean </IsDefault>
          <Name> string </Name>
        </CategoryGroup>
        <ProfileID> long </ProfileID>
        <ProfileName> string </ProfileName>
        <ProfileType> string </ProfileType>
        <ShortSummary> string </ShortSummary>
      </SupportedSellerProfile>
      <!-- ... more SupportedSellerProfile nodes allowed here ... -->
    </SupportedSellerProfiles>
  </SellerProfilePreferences>
  <SellerReturnPreferences> SellerReturnPreferencesType
    <OptedIn> boolean </OptedIn>
  </SellerReturnPreferences>
  <UnpaidItemAssistancePreferences> UnpaidItemAssistancePreferencesType
    <AutoRelist> boolean </AutoRelist>
    <DelayBeforeOpeningDispute> int </DelayBeforeOpeningDispute>
    <ExcludedUser> string </ExcludedUser>
    <!-- ... more ExcludedUser values allowed here ... -->
    <OptInStatus> boolean </OptInStatus>
    <RemoveAllExcludedUsers> boolean </RemoveAllExcludedUsers>
  </UnpaidItemAssistancePreferences>
  <!-- Standard Output Fields -->
  <Ack> AckCodeType </Ack>
  <Build> string </Build>
  <CorrelationID> string </CorrelationID>
  <Errors> ErrorType
    <ErrorClassification> ErrorClassificationCodeType </ErrorClassification>
    <ErrorCode> token </ErrorCode>
    <ErrorParameters ParamID="string"> ErrorParameterType
      <Value> string </Value>
    </ErrorParameters>
    <!-- ... more ErrorParameters nodes allowed here ... -->
    <LongMessage> string </LongMessage>
    <SeverityCode> SeverityCodeType </SeverityCode>
    <ShortMessage> string </ShortMessage>
  </Errors>
  <!-- ... more Errors nodes allowed here ... -->
  <HardExpirationWarning> string </HardExpirationWarning>
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
</GetUserPreferencesResponse>

Return Value	Type	Occurrence	Meaning

Call-specific Output Fields [Jump to standard fields]

BidderNoticePreferences	BidderNoticePreferencesType	Conditionally	Container consisting of the seller's preference for receiving contact information for unsuccessful bidders. This container is returned when ShowBidderNoticePreferences is included and set to `true` in the request. This preference is only applicable for auction listings.
BidderNoticePreferences .UnsuccessfulBidderNoticeIncludeMyItems	boolean	Conditionally	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	Conditionally	Container consisting of the seller's Combined Invoice preferences. These preferences are used to allow Combined Invoice orders. This container is returned when ShowCombinedPaymentPreferences is included and set to `true` in the request. See Combined invoice.
CombinedPaymentPreferences .CombinedPaymentOption	CombinedPaymentOptionCodeType	Conditionally	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. Code so that your app gracefully handles any future changes to this list. See Combined Invoice.
DispatchCutoffTimePreference	DispatchCutoffTimePreferencesType	Conditionally	Contains information about a seller's order cutoff time preferences for same-day shipping. If the seller specifies a value of '0' in Item.DispatchTimeMax to offer same-day handling when listing an item, the seller's shipping time commitment depends on the order cutoff time set for the listing site, as indicated by DispatchCutoffTimePreference.CutoffTime. Returned when ShowDispatchCutoffTimePreferences is included and set to `true`. Note: For sellers opted in to the feature that supports different order cutoff times for each business day, the order cutoff time returned in this container may not be accurate. In order for the seller to confirm the actual order cutoff time for same-day handling, that seller should view Shipping Preferences in My eBay. See Same day handling.
DispatchCutoffTimePreference .CutoffTime	time	Conditionally	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.
eBayPLUSPreference	EBayPLUSPreferenceType	Conditionally, repeatable: [0..*]	Contains information about each country where the seller is eligible to offer eBay Plus on listings (one eBayPLUSPreference container per country), as well as the seller's opt-in status and listing preference for each country. eBay Plus is a premium account option for buyers, which provides benefits such as fast free domestic shipping and free returns on selected items. Top Rated eBay sellers must opt in to eBay Plus to offer the program on a per-listing basis. Note: Currently, eBay Plus is available only to buyers in Germany and Australia. In Australia, the seller has no control/responsibility over setting the eBay Plus feature for a listing. Instead, eBay will evaluate/determine whether a listing is eligible for eBay Plus. See eBay Plus for more details.
eBayPLUSPreference.Country	CountryCodeType	Conditionally	An ISO 3166 standard two-letter code that identifies a country where the seller is eligible to offer eBay Plus on fixed price listings. Note: Currently, eBay Plus is available only to buyers in Germany and Australia. Applicable values: See Country. Code so that your app gracefully handles any future changes to this list.
eBayPLUSPreference .ListingPreference	boolean	Conditionally	A value of `true` indicates that if OptInStatus is also `true`, the seller will offer eBay Plus by default for new listings in the specified country. If this field's value is `false` (and OptInStatus is `true`), the seller will offer eBay Plus on a listing by listing basis in the specified country.
eBayPLUSPreference.OptInStatus	boolean	Conditionally	A value of `true` indicates that the seller has opted in to eBay Plus for listings in the specified country.
EmailShipmentTrackingNumberPreference	boolean	Conditionally	Container consisting of the seller's preference for sending an email to the buyer with the shipment tracking number. This container is returned when ShowEmailShipmentTrackingNumberPreference is included and set to `true` in the request.
EndOfAuctionEmailPreferences	EndOfAuctionEmailPreferencesType	Conditionally	Container consisting of the seller's preferences for the end-of-auction email sent to the winning bidder. This container is returned when ShowEndOfAuctionEmailPreferences is included and set to `true` in the request. These preferences are only applicable for auction listings.
EndOfAuctionEmailPreferences .EmailCustomized	boolean	Always	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	Conditionally	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	Always	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'). None (out) This enumeration value indicates that no logo will be used in the end of auction email to winning bidder. 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. Code so that your app gracefully handles any future changes to this list.
EndOfAuctionEmailPreferences .LogoURL	anyURI	Conditionally	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	Conditionally	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	Conditionally	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	Conditionally	If the ShowGlobalShippingProgramListingPreference field is submitted and set to `true`, this flag is returned. A returned value of `true` indicates that the seller's new listings will enable the Global Shipping Program by default.
OfferGlobalShippingProgramPreference	boolean	Conditionally	This flag indicates whether the seller has opted in to the Global Shipping Program and is able to offer global shipping to international buyers. Returned when ShowGlobalShippingProgramPreference is included and set to `true`.
OutOfStockControlPreference	boolean	Conditionally	This boolean field is returned if the ShowOutOfStockControlPreference field is included and set to `true` in the request. This field will be returned as `true` if the seller has set SetUserPreferences.OutOfStockControlPreference to `true`. See Out-of-Stock control.
OverrideGSPServiceWithIntlServicePreference	boolean	Conditionally	If the ShowOverrideGSPServiceWithIntlServicePreference field is submitted and set to `true`, this flag is returned. A returned value of `true` indicates that for the seller's listings that specify an international shipping service for any Global Shipping-eligible country, the specified service will take precedence and be the listing's default international shipping option for buyers in that country, rather than the Global Shipping Program. A returned value of `false` indicates that the Global Shipping program will take precedence over any international shipping service as the default option in Global Shipping-eligible listings for shipping to any Global Shipping-eligible country.
PickupDropoffSellerPreference	boolean	Conditionally	This boolean field is returned if the ShowPickupDropoffPreferences field is included and set to `true` in the request. This field will be returned as `true` if the seller has enabled the Click and Collect feature at the account level. All of the seller's new listings will by default be eligible to be evaluated for the Click and Collect feature. With the Click and Collect feature, a buyer can purchase certain items on eBay and collect them at a local store. Buyers are notified by eBay once their items are available. The Click and Collect feature is only available to large merchants on the eBay UK (site ID 3), eBay Australia (Site ID 15), and eBay Germany (Site ID 77) sites. Note: The Click and Collect program no longer allows sellers to set the Click and Collect preference at the listing level.
PurchaseReminderEmailPreferences	PurchaseReminderEmailPreferencesType	Conditionally	Container consisting of a seller's preference for sending a purchase reminder email to buyers. This container is returned if the ShowPurchaseReminderEmailPreferences field is included and set to `true` in the request.
PurchaseReminderEmailPreferences .PurchaseReminderEmailPreferences	boolean	Conditionally	If true, a payment reminder Email is sent to buyers.
RequiredShipPhoneNumberPreference	boolean	Conditionally	Container consisting of the seller's preference for requiring that the buyer supply a shipping phone number upon checkout. Some shipping carriers require the receiver's phone number. This container is returned when ShowRequiredShipPhoneNumberPreference is included and set to `true` in the request.
SellerExcludeShipToLocationPreferences	SellerExcludeShipToLocationPreferencesType	Conditionally	Container consisting of a list of the seller's excluded shipping locations. The returned list mirrors the seller's current Exclude shipping locations list in My eBay's shipping preferences. An excluded shipping location in My eBay can be an entire geographical region (such as Middle East) or only an individual country (such as Iraq). Sellers can override these default settings for an individual listing by using the Item.ShippingDetails.ExcludeShipToLocation field in the Add/Revise/Relist calls. This container is returned if the ShowSellerExcludeShipToLocationPreference field is included and set to `true` in the request.
SellerExcludeShipToLocationPreferences .ExcludeShipToLocation	string	Conditionally, repeatable: [0..*]	One ExcludeShipToLocation field is returned for each geographical region or country excluded as a possible shipping location in the seller's My eBay Shipping Preferences. Sellers can also exclude Alaska/Hawaii and Army Post Office/Fleet Post Office as possible shipping locations. For excluded countries, ISO 3166 country codes are returned. Domestically, the seller can specify Alaska/Hawaii, US Protectorates (including American Samoa, Guam, Mariana Island, Marshall Islands, Micronesia, Palau, Puerto Rico, and U.S. Virgin Islands) as places he/she will not ship to. Internationally, the sellers can exclude entire regions (including Africa, Asia, Central America and Caribbean, Europe, Middle East, North America, Oceania, Southeast Asia, and South America) or specific countries within those regions. If a buyer's primary ship-to location is a location that you have listed as an excluded ship-to location (or if the buyer does not have a primary ship-to location), they will receive an error message if they attempt to buy or place a bid on your item. To see the valid exclude ship-to locations for a specified site, call GeteBayDetails with a DetailName field set to ExcludeShippingLocationDetails.
SellerFavoriteItemPreferences	SellerFavoriteItemPreferencesType	Conditionally	Container consisting of the seller's preferences for displaying items on a buyer's Favorite Sellers' Items page or Favorite Sellers' Items digest. This container is returned when ShowSellerFavoriteItemPreferences is included and set to `true` in the request.
SellerFavoriteItemPreferences .FavoriteItemID	ItemIDType (string)	Conditionally, repeatable: [0..*]	Specifies the list of favorite items.
SellerFavoriteItemPreferences .ListingType	ListingTypeCodeType	Conditionally	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.) Code so that your app gracefully handles any future changes to this list.
SellerFavoriteItemPreferences .MaxPrice	AmountType (double)	Conditionally	Specifies the upper limit of price range for the automatic search criteria.
SellerFavoriteItemPreferences .MaxPrice [ attribute currencyID ]	CurrencyCodeType	Always	Specifies the upper limit of price range for the automatic search criteria. For a list of possible enumeration values, see CurrencyCodeType.
SellerFavoriteItemPreferences .MinPrice	AmountType (double)	Conditionally	Specifies the lower limit of price range for the automatic search criteria.
SellerFavoriteItemPreferences .MinPrice [ attribute currencyID ]	CurrencyCodeType	Always	Specifies the lower limit of price range for the automatic search criteria. For a list of possible enumeration values, see CurrencyCodeType.
SellerFavoriteItemPreferences .SearchKeywords	string	Conditionally	The keywords in the item title for the automatic item search criteria.
SellerFavoriteItemPreferences .SearchSortOrder	StoreItemListSortOrderCodeType	Conditionally	The sort order chosen from the standard ebay sorts for the automatic search criteria. Applicable values: See SearchSortOrder. Code so that your app gracefully handles any future changes to this list.
SellerFavoriteItemPreferences .StoreCategoryID	long	Conditionally	(For eBay Store owners only) The store custom category for the automatic item search criteria.
SellerPaymentPreferences	SellerPaymentPreferencesType	Conditionally	Container consisting of the seller's payment preferences. This container is returned when ShowSellerPaymentPreferences is included and set to `true` in the request.
SellerPaymentPreferences .AlwaysUseThisPaymentAddress	boolean	Conditionally	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	Conditionally	This field is deprecated. If it is used in a SetUserPreferences call, it is ignored.
SellerPaymentPreferences .DisplayPayNowButton	DisplayPayNowButtonCodeType (token)	Conditionally	This field is deprecated. If it is used in a SetUserPreferences call, it is ignored.
SellerPaymentPreferences .FedExRateOption	FedExRateOptionCodeType	Conditionally	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. Code so that your app gracefully handles any future changes to this list.
SellerPaymentPreferences .PayPalAlwaysOn	boolean	Conditionally	This field is deprecated. If it is used in a SetUserPreferences call, it is ignored.
SellerPaymentPreferences .PayPalPreferred	boolean	Conditionally	This field is deprecated. If it is used in a SetUserPreferences call, it is ignored.
SellerPaymentPreferences .SellerPaymentAddress	AddressType	Conditionally	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	Conditionally	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. Code so that your app gracefully handles any future changes to this list.
SellerPaymentPreferences .UPSRateOption	UPSRateOptionCodeType	Conditionally	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. Code so that your app gracefully handles any future changes to this list.
SellerPaymentPreferences .USPSRateOption	USPSRateOptionCodeType	Conditionally	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. Code so that your app gracefully handles any future changes to this list.
SellerProfilePreferences	SellerProfilePreferencesType	Conditionally	Parent response container consisting of high-level information for all Business Policies defined for the user's account. This container is returned if ShowSellerProfilePreferences is included and set to `true` in the GetUserPreferences request (and one or more Business Policies are defined for the user's account).
SellerProfilePreferences .SellerProfileOptedIn	boolean	Conditionally	Boolean flag indicating whether or not a seller has opted in to Business Policies. Sellers must opt in to Business Policies to create and manage payment, return policy, and shipping profiles.
SellerProfilePreferences .SupportedSellerProfiles	SupportedSellerProfilesType	Conditionally	Container consisting of one or more Business Policies profiles active for a seller's account. This container is only returned if SellerProfileOptedIn = SellerProfilePreferences and the seller has one or more Business Policies profiles active on the account.
SellerProfilePreferences .SupportedSellerProfiles .SupportedSellerProfile	SupportedSellerProfileType	Conditionally, repeatable: [0..*]	Container consisting of information related to specific Business Policies payment, return, and shipping policy profiles. The profile type is found in the ProfileType field.
SellerProfilePreferences .SupportedSellerProfiles .SupportedSellerProfile .CategoryGroup	CategoryGroupType	Conditionally	Identifies the the Business Policies category group associated with the Business Policies profile. Current values are ALL (referring to all non-motor vehicle categories) and MOTORS_VEHICLE (for motor vehicle listings).
SellerProfilePreferences .SupportedSellerProfiles .SupportedSellerProfile .CategoryGroup.IsDefault	boolean	Conditionally	This boolean value indicates whether the corresponding Business Policies profile is the default for the category group. The CategoryGroup container is only returned in GetUserPreferences if the ShowSellerProfilePreferences field is included in the request and set to `true`.
SellerProfilePreferences .SupportedSellerProfiles .SupportedSellerProfile .CategoryGroup.Name	string	Conditionally	Defines the name of the category group tied to a Business Policies profile. Valid values are `ALL` (referring to all non-motor vehicle category groups) or `MOTORS_VEHICLE` (referring to only motor vehicle category groups). The CategoryGroup container is only returned in GetUserPreferences if the ShowSellerProfilePreferences field is included in the request and set to `true`.
SellerProfilePreferences .SupportedSellerProfiles .SupportedSellerProfile .ProfileID	long	Conditionally	Unique identifier of a Business Policies profile. This identifier is auto-generated by eBay when the seller creates the profile. This field is always returned with the SupportedSellerProfile container.
SellerProfilePreferences .SupportedSellerProfiles .SupportedSellerProfile .ProfileName	string	Conditionally	The seller-defined name for a Business Policies profile. This field is always returned with the SupportedSellerProfile container.
SellerProfilePreferences .SupportedSellerProfiles .SupportedSellerProfile .ProfileType	string	Conditionally	Indicates the type of the Business Policies profile. Valid values are PAYMENT, RETURN_POLICY, and SHIPPING. This field is always returned with the SupportedSellerProfile container.
SellerProfilePreferences .SupportedSellerProfiles .SupportedSellerProfile .ShortSummary	string	Conditionally	Seller-provided description of a Business Policies profile. This field is only returned if a seller has provided a description for the profile.
SellerReturnPreferences	SellerReturnPreferencesType	Conditionally	Container consisting of the OptedIn flag that indicates whether or not the seller has opted in to eBay Managed Returns. This container is only returned if ShowSellerReturnPreferences is included and set to `true` in the request.
SellerReturnPreferences .OptedIn	boolean	Conditionally	This flag indicates whether or not an eligible seller has opted in to eBay Managed Returns through the Return Preferences of My eBay.
UnpaidItemAssistancePreferences	UnpaidItemAssistancePreferencesType	Conditionally	Container consisting of a seller's Unpaid Item preferences. The Unpaid Item preferences can be used to automatically cancel an unpaid order and relist the item on the behalf of the seller. This container is returned if ShowUnpaidItemAssistancePreference is included and set to `true` in the request. Note: To return the list of buyers excluded from the Unpaid Item preferences, the ShowUnpaidItemAssistanceExclusionList field must also be included and set to `true` in the request. Excluded buyers can be viewed in the UnpaidItemAssistancePreferences.ExcludedUser field.
UnpaidItemAssistancePreferences .AutoRelist	boolean	Conditionally	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	Conditionally	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	Conditionally, 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	Conditionally	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	Conditionally	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 Output Fields

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.

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.

Available samples:

Basic Call ↓ - Gets the settings for a specified set of user preferences.
All User Preferences ↓ - Gets the settings for the entire set of user preferences.

Sample: Basic Call

Gets the settings for a specified set of user preferences.

Description

A seller wants to check her user preference settings.

Input

Seller wants to review payment preferences and the settings for her Exclude Ship-To Locations.

Note that the Exclude Ship-to Location preferences are set through the eBay User Account UI, and not through the SetUserPreferences call.

XML format.

<?xml version="1.0" encoding="utf-8"?> 
<GetUserPreferencesRequest xmlns="urn:ebay:apis:eBLBaseComponents"> 
  <RequesterCredentials> 
    <eBayAuthToken>A*******3</eBayAuthToken> 
  </RequesterCredentials> 
  <ShowSellerPaymentPreferences>true</ShowSellerPaymentPreferences>
  <ShowSellerExcludeShipToLocationPreference>true</ShowSellerExcludeShipToLocationPreference>
</GetUserPreferencesRequest>

Output

The user's Payment preferences and Exclude Ship-To Location preferences are returned.

XML format.
<?xml version="1.0" encoding="UTF-8"?>
<GetUserPreferencesResponse 
  xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2019-11-06T17:20:08.235Z</Timestamp>
  <Ack>Success</Ack>
  <Version>1127</Version>
  <Build>E1127_CORE_APISELLING_19076920_R1</Build>
  <SellerPaymentPreferences>
    <DisplayPayNowButton>ShowPayNowButtonForAllPaymentMethods</DisplayPayNowButton>
    <PayPalPreferred>false</PayPalPreferred>
    <DefaultPayPalEmailAddress>r*****@******.com</DefaultPayPalEmailAddress>
    <PayPalAlwaysOn>true</PayPalAlwaysOn>
    <UPSRateOption>UPSDailyRates</UPSRateOption>
  </SellerPaymentPreferences>
  <SellerExcludeShipToLocationPreferences>
    <ExcludeShipToLocation>YE</ExcludeShipToLocation>
    <ExcludeShipToLocation>QA</ExcludeShipToLocation>
    <ExcludeShipToLocation>SA</ExcludeShipToLocation>
    <ExcludeShipToLocation>IQ</ExcludeShipToLocation>
    <ExcludeShipToLocation>IL</ExcludeShipToLocation>
    <ExcludeShipToLocation>KW</ExcludeShipToLocation>
    <ExcludeShipToLocation>BH</ExcludeShipToLocation>
    <ExcludeShipToLocation>JO</ExcludeShipToLocation>
    <ExcludeShipToLocation>OM</ExcludeShipToLocation>
    <ExcludeShipToLocation>TR</ExcludeShipToLocation>
    <ExcludeShipToLocation>AE</ExcludeShipToLocation>
    <ExcludeShipToLocation>Middle East</ExcludeShipToLocation>
    <ExcludeShipToLocation>LB</ExcludeShipToLocation>
  </SellerExcludeShipToLocationPreferences>
</GetUserPreferencesResponse>

Back to list of samples

Sample: All User Preferences

Gets the settings for the entire set of user preferences.

Description

A seller wants to check all of her user preference settings.

Input

Seller wants to review all user preferences.

XML format.

<?xml version="1.0" encoding="utf-8"?> 
<GetUserPreferencesRequest xmlns="urn:ebay:apis:eBLBaseComponents"> 
  <RequesterCredentials>
    <eBayAuthToken>A*******3</eBayAuthToken>
  </RequesterCredentials>
  <ErrorLanguage>en_US</ErrorLanguage>
  <WarningLevel>High</WarningLevel>
  <ShowBidderNoticePreferences>true</ShowBidderNoticePreferences>
  <ShowCombinedPaymentPreferences>true</ShowCombinedPaymentPreferences>
  <ShowDispatchCutoffTimePreferences>true</ShowDispatchCutoffTimePreferences>
  <ShoweBayPLUSPreference>true</ShoweBayPLUSPreference>
  <ShowEmailShipmentTrackingNumberPreference>true</ShowEmailShipmentTrackingNumberPreference>
  <ShowEndOfAuctionEmailPreferences>true</ShowEndOfAuctionEmailPreferences>
  <ShowGlobalShippingProgramListingPreference>true</ShowGlobalShippingProgramListingPreference>
  <ShowGlobalShippingProgramPreference>true</ShowGlobalShippingProgramPreference>
  <ShowOutOfStockControlPreference>true</ShowOutOfStockControlPreference>
  <ShowOverrideGSPServiceWithIntlServicePreference>true</ShowOverrideGSPServiceWithIntlServicePreference>
  <ShowPickupDropoffPreferences>true</ShowPickupDropoffPreferences>
  <ShowPurchaseReminderEmailPreferences>true</ShowPurchaseReminderEmailPreferences>
  <ShowRequiredShipPhoneNumberPreference>true</ShowRequiredShipPhoneNumberPreference>
  <ShowSellerExcludeShipToLocationPreference>true</ShowSellerExcludeShipToLocationPreference>
  <ShowSellerFavoriteItemPreferences>true</ShowSellerFavoriteItemPreferences>
  <ShowSellerPaymentPreferences>true</ShowSellerPaymentPreferences>
  <ShowSellerProfilePreferences>true</ShowSellerProfilePreferences>
  <ShowSellerReturnPreferences>true</ShowSellerReturnPreferences>
  <ShowUnpaidItemAssistanceExclusionList>true</ShowUnpaidItemAssistanceExclusionList>
  <ShowUnpaidItemAssistancePreference>true</ShowUnpaidItemAssistancePreference>
</GetUserPreferencesRequest>

Output

All user preferences are returned in the response.

XML format.
<?xml version="1.0" encoding="UTF-8"?>
<GetUserPreferencesResponse 
  xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2019-11-06T17:13:23.570Z</Timestamp>
  <Ack>Success</Ack>
  <Version>1131</Version>
  <Build>E1131_CORE_APISELLING_19099826_R1</Build>
  <BidderNoticePreferences/>
  <CombinedPaymentPreferences>
    <CombinedPaymentOption>SpecifyDiscountLater</CombinedPaymentOption>
  </CombinedPaymentPreferences>
  <SellerPaymentPreferences>
    <DisplayPayNowButton>ShowPayNowButtonForAllPaymentMethods</DisplayPayNowButton>
    <PayPalPreferred>false</PayPalPreferred>
    <DefaultPayPalEmailAddress>r*****@******.com</DefaultPayPalEmailAddress>
    <PayPalAlwaysOn>true</PayPalAlwaysOn>
    <UPSRateOption>UPSDailyRates</UPSRateOption>
  </SellerPaymentPreferences>
  <SellerFavoriteItemPreferences>
    <StoreCategoryID>0</StoreCategoryID>
    <ListingType>LeadGeneration</ListingType>
    <SearchSortOrder>NewlyListed</SearchSortOrder>
    <MinPrice currencyID="USD">-1.0</MinPrice>
    <MaxPrice currencyID="USD">-1.0</MaxPrice>
    <FavoriteItemID>*</FavoriteItemID>
    <FavoriteItemID>*</FavoriteItemID>
    <FavoriteItemID>*</FavoriteItemID>
    <FavoriteItemID>*</FavoriteItemID>
  </SellerFavoriteItemPreferences>
  <EndOfAuctionEmailPreferences>
    <TemplateText>this is my custom text that i just changed</TemplateText>
    <LogoType>Store</LogoType>
    <EmailCustomized>false</EmailCustomized>
    <TextCustomized>false</TextCustomized>
    <LogoCustomized>false</LogoCustomized>
    <CopyEmail>false</CopyEmail>
  </EndOfAuctionEmailPreferences>
  <EmailShipmentTrackingNumberPreference>false</EmailShipmentTrackingNumberPreference>
  <RequiredShipPhoneNumberPreference>false</RequiredShipPhoneNumberPreference>
  <UnpaidItemAssistancePreferences>
    <DelayBeforeOpeningDispute>30</DelayBeforeOpeningDispute>
    <OptInStatus>true</OptInStatus>
    <AutoRelist>false</AutoRelist>
    <ExcludedUser>r******9</ExcludedUser>
  </UnpaidItemAssistancePreferences>
  <SellerExcludeShipToLocationPreferences>
    <ExcludeShipToLocation>YE</ExcludeShipToLocation>
    <ExcludeShipToLocation>QA</ExcludeShipToLocation>
    <ExcludeShipToLocation>SA</ExcludeShipToLocation>
    <ExcludeShipToLocation>IQ</ExcludeShipToLocation>
    <ExcludeShipToLocation>IL</ExcludeShipToLocation>
    <ExcludeShipToLocation>KW</ExcludeShipToLocation>
    <ExcludeShipToLocation>BH</ExcludeShipToLocation>
    <ExcludeShipToLocation>JO</ExcludeShipToLocation>
    <ExcludeShipToLocation>OM</ExcludeShipToLocation>
    <ExcludeShipToLocation>TR</ExcludeShipToLocation>
    <ExcludeShipToLocation>AE</ExcludeShipToLocation>
    <ExcludeShipToLocation>Middle East</ExcludeShipToLocation>
    <ExcludeShipToLocation>LB</ExcludeShipToLocation>
  </SellerExcludeShipToLocationPreferences>
  <PurchaseReminderEmailPreferences>
    <PurchaseReminderEmailPreferences>true</PurchaseReminderEmailPreferences>
  </PurchaseReminderEmailPreferences>
  <SellerProfilePreferences>
    <SellerProfileOptedIn>true</SellerProfileOptedIn>
    <SupportedSellerProfiles>
      <SupportedSellerProfile>
        <ProfileID>1**********0</ProfileID>
        <ProfileType>PAYMENT</ProfileType>
        <ProfileName>e***************************************s</ProfileName>
        <ShortSummary>eBay Payments</ShortSummary>
        <CategoryGroup>
          <Name>ALL</Name>
          <IsDefault>false</IsDefault>
        </CategoryGroup>
      </SupportedSellerProfile>
      <SupportedSellerProfile>
        <ProfileID>3*********0</ProfileID>
        <ProfileType>PAYMENT</ProfileType>
        <ProfileName>P******************y</ProfileName>
        <ShortSummary>PayPal, r*****@g*****.com</ShortSummary>
        <CategoryGroup>
          <Name>ALL</Name>
          <IsDefault>true</IsDefault>
        </CategoryGroup>
      </SupportedSellerProfile>
      <SupportedSellerProfile>
        <ProfileID>1**********0</ProfileID>
        <ProfileType>PAYMENT</ProfileType>
        <ProfileName>P****l</ProfileName>
        <ShortSummary>PayPal, r*****@g*****.com</ShortSummary>
        <CategoryGroup>
          <Name>ALL</Name>
          <IsDefault>false</IsDefault>
        </CategoryGroup>
      </SupportedSellerProfile>
      <SupportedSellerProfile>
        <ProfileID>1**********0</ProfileID>
        <ProfileType>PAYMENT</ProfileType>
        <ProfileName>e*************************s</ProfileName>
        <ShortSummary>eBay Payments</ShortSummary>
        <CategoryGroup>
          <Name>ALL</Name>
          <IsDefault>false</IsDefault>
        </CategoryGroup>
      </SupportedSellerProfile>
      <SupportedSellerProfile>
        <ProfileID>1**********0</ProfileID>
        <ProfileType>RETURN_POLICY</ProfileType>
        <ProfileName>r********************************************t</ProfileName>
        <ShortSummary>Return policy for rare books.</ShortSummary>
        <CategoryGroup>
          <Name>ALL</Name>
          <IsDefault>false</IsDefault>
        </CategoryGroup>
      </SupportedSellerProfile>
      <SupportedSellerProfile>
        <ProfileID>1**********0</ProfileID>
        <ProfileType>RETURN_POLICY</ProfileType>
        <ProfileName>P*****************y</ProfileName>
        <CategoryGroup>
          <Name>ALL</Name>
          <IsDefault>false</IsDefault>
        </CategoryGroup>
      </SupportedSellerProfile>
      <SupportedSellerProfile>
        <ProfileID>1**********0</ProfileID>
        <ProfileType>RETURN_POLICY</ProfileType>
        <ProfileName>R********************************************0</ProfileName>
        <ShortSummary>Returns Accepted, Buyer, 30 Days, Money back or replacement (buyer's choice)</ShortSummary>
        <CategoryGroup>
          <Name>ALL</Name>
          <IsDefault>false</IsDefault>
        </CategoryGroup>
      </SupportedSellerProfile>
      <SupportedSellerProfile>
        <ProfileID>1**********0</ProfileID>
        <ProfileType>RETURN_POLICY</ProfileType>
        <ProfileName>R******************************************r</ProfileName>
        <ShortSummary>Returns Accepted, Buyer, 60 Days, Money back</ShortSummary>
        <CategoryGroup>
          <Name>ALL</Name>
          <IsDefault>true</IsDefault>
        </CategoryGroup>
      </SupportedSellerProfile>
      <SupportedSellerProfile>
        <ProfileID>3*********0</ProfileID>
        <ProfileType>RETURN_POLICY</ProfileType>
        <ProfileName>N*****************d</ProfileName>
        <ShortSummary>No returns accepted</ShortSummary>
        <CategoryGroup>
          <Name>ALL</Name>
          <IsDefault>false</IsDefault>
        </CategoryGroup>
      </SupportedSellerProfile>
      <SupportedSellerProfile>
        <ProfileID>1**********0</ProfileID>
        <ProfileType>SHIPPING</ProfileType>
        <ProfileName>C*********************************************1</ProfileName>
        <ShortSummary>Domestic: Calculated: Standard services($0.00) Otherservices. International: Calculated: USPS Priority Mail International Small Flat Rate Box</ShortSummary>
        <CategoryGroup>
          <Name>ALL</Name>
          <IsDefault>false</IsDefault>
        </CategoryGroup>
      </SupportedSellerProfile>
      <SupportedSellerProfile>
        <ProfileID>1**********0</ProfileID>
        <ProfileType>SHIPPING</ProfileType>
        <ProfileName>T*************t</ProfileName>
        <ShortSummary>Shipping policy for tractors</ShortSummary>
        <CategoryGroup>
          <Name>ALL</Name>
          <IsDefault>false</IsDefault>
        </CategoryGroup>
      </SupportedSellerProfile>
      <SupportedSellerProfile>
        <ProfileID>1**********0</ProfileID>
        <ProfileType>SHIPPING</ProfileType>
        <ProfileName>C*********************************************1</ProfileName>
        <ShortSummary>Domestic: Calculated: Expedited services($7.25) Otherservices.</ShortSummary>
        <CategoryGroup>
          <Name>ALL</Name>
          <IsDefault>false</IsDefault>
        </CategoryGroup>
      </SupportedSellerProfile>
      <SupportedSellerProfile>
        <ProfileID>1**********0</ProfileID>
        <ProfileType>SHIPPING</ProfileType>
        <ProfileName>F****************d</ProfileName>
        <CategoryGroup>
          <Name>ALL</Name>
          <IsDefault>false</IsDefault>
        </CategoryGroup>
      </SupportedSellerProfile>
      <SupportedSellerProfile>
        <ProfileID>1**********0</ProfileID>
        <ProfileType>SHIPPING</ProfileType>
        <ProfileName>C***************************************2</ProfileName>
        <ShortSummary>Domestic: Calculated: Expedited services.</ShortSummary>
        <CategoryGroup>
          <Name>ALL</Name>
          <IsDefault>false</IsDefault>
        </CategoryGroup>
      </SupportedSellerProfile>
      <SupportedSellerProfile>
        <ProfileID>1**********0</ProfileID>
        <ProfileType>SHIPPING</ProfileType>
        <ProfileName>C******************************************p/</ProfileName>
        <ShortSummary>Domestic: Calculated: Standard services($0.00) Otherservices. International: Calculated: USPS First Class Mail International / First Class Package International Service</ShortSummary>
        <CategoryGroup>
          <Name>ALL</Name>
          <IsDefault>false</IsDefault>
        </CategoryGroup>
      </SupportedSellerProfile>
    </SupportedSellerProfiles>
  </SellerProfilePreferences>
  <SellerReturnPreferences>
    <OptedIn>true</OptedIn>
  </SellerReturnPreferences>
  <OfferGlobalShippingProgramPreference>true</OfferGlobalShippingProgramPreference>
  <DispatchCutoffTimePreference>
    <CutoffTime>20:00:00.000Z</CutoffTime>
  </DispatchCutoffTimePreference>
  <GlobalShippingProgramListingPreference>true</GlobalShippingProgramListingPreference>
  <OverrideGSPServiceWithIntlServicePreference>true</OverrideGSPServiceWithIntlServicePreference>
  <PickupDropoffSellerPreference>false</PickupDropoffSellerPreference>
  <OutOfStockControlPreference>true</OutOfStockControlPreference>
  <eBayPLUSPreference>
    <Country>DE</Country>
    <OptInStatus>false</OptInStatus>
  </eBayPLUSPreference>
</GetUserPreferencesResponse>

Back to list of samples

Change History

Change Date	Description
1049 2018-02-16	ShowPickupDropoffPreferences (doc change): A note was added in the field description of this request field about sellers only being able to enable the Click and Collect feature at the account level, and then each individual listing within a Click and Collect-enabled category must be evaluated for eligibility. PickupDropoffSellerPreference (doc change): A note was added in the field description of this response field about sellers only being able to enable the Click and Collect feature at the account level, and then each individual listing within a Click and Collect-enabled category must be evaluated for eligibility.
0933 2015-07-24	ShoweBayPLUSPreference (added): This new boolean field accepts a boolean value that should be set to 'true' to return the seller's eBayPLUS regional eligibility, opt-in status, and preferences. eBay Plus is a premium account option for buyers, which provides benefits such as fast free domestic shipping and free returns on selected items. Currently available only in Germany. eBayPLUSPreference (added): This new container is returned only if the ShoweBayPLUSPreference field is included and set to 'true' in the request. This container includes seller opt-in status and listing preference for each country or region where the eBayPLUS program is available. eBay Plus is a premium account option for buyers, which provides benefits such as fast free domestic shipping and free returns on selected items. Currently available only in Germany.
0879 2014-06-17	Request.ShowPickupDropoffPreferences (added): This new field should be included and set to 'true' to see if the 'Click and Collect' feature is enabled for the seller at the account level. Response.ShowPickupDropoffPreferences (added): This container is only returned if the ShowPickupDropoffPreferences flag is included and set to 'true' in the response. The PickupDropoffSellerPreference flag is this container will indicate whether or not the 'Click and Collect' feature is enabled for the seller at the account level.
0849 2013-11-05	ShowOverrideGSPServiceWithIntlServicePreference (added): Set this boolean field to true to determine whether the current seller can offer an international shipping service to a particular country as the default for a Global Shipping-eligible listing, rather than the Global Shipping Program. OverrideGSPServiceWithIntlServicePreference (added): When ShowOverrideGSPServiceWithIntlServicePreference is submitted with a value of true, this boolean field is returned to indicate whether the current seller can offer an international shipping service to a particular country as the default for a Global Shipping-eligible listing, rather than the Global Shipping Program.
0837 2013-08-29	ShowSellerReturnPreferences (doc change): Added a note in the description that eBay Managed Returns is coming to the UK site beginning in late September 2013. SellerReturnPreferences (doc change): Added a note in the description that eBay Managed Returns is coming to the UK site beginning in late September 2013.
0829 2013-06-19	ShowGlobalShippingProgramListingPreference (added): Set this field to true to determine whether a seller's new listings will enable the Global Shipping Program by default. GlobalShippingProgramListingPreference (added): When ShowGlobalShippingProgramListingPreference is submitted with a value of true, this boolean field is returned to indicate whether a seller's new listings will enable the Global Shipping Program by default.
0825 2013-05-22	SellerPaymentPreferences.FedExRateOption (modified): A new enumeration value, FedExDiscounted, can be returned in FedExRateOption, indicating that the FedEx Discounted shipping rate scale has been selected for the user.
0817 2013-03-27	ShowDispatchCutoffTimePreferences (added): If this flag is included and set to true, the seller's same day handling cut off time is returned in DispatchCutoffTimePreference.CutoffTime. 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).
0797 2012-10-24	ShowCrossPromotionPreferences (modified): This flag should no longer be used as eBay Store Cross Promotions are no longer supported in the Trading API. This field will be removed from the Trading WSDL and API Call Reference docs in a future release. CrossPromotionPreferences (modified): This container is no longer applicable 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.
0785 2012-08-01	GetUserPreferencesRequest.ShowGlobalShippingProgramPreference (added): Boolean input flag used to request the seller's preference for offering the Global Shipping Program to international buyers. GetUserPreferencesResponse.OfferGlobalShippingProgramPreference (added): Boolean output flag indicating the seller's preference for offering the Global Shipping Program to international buyers.
0783 2012-07-18	GetUserPreferencesRequest.ShowSellerReturnPreferences (added): Boolean flag used to return the seller's eBay Return Center preferences. GetUserPreferencesResponse.SellerReturnPreferences (added): Container consisting of the seller's eBay Return Center preferences.
0763 2012-02-28	GetUserPreferencesRequest.ShowSellerProfilePreferences (added): Boolean flag used to return all Business Policies profiles active on the user's account. GetUserPreferencesResponse.SellerProfilePreferences (added): Container consisting of all Business Policies profiles active on the user's account, as well as a flag to indicate if the seller is opted into Business Policies. GetUserPreferencesResponse.SellerProfilePreferences.SupportedSellerProfiles (added): Top-level container for all Business Policies profiles active on the seller's account. GetUserPreferencesResponse.SellerProfilePreferences.SupportedSellerProfiles.SupportedSellerProfile (added): Container consisting of summary information for a specific Business Policies profile (payment, return policy, or shipping).
0745 2011-10-26	UnpaidItemAssistancePreferences.AutoOptDonationRefund (added): This flag indicates that the seller wants eBay to automatically request eBay Giving Works donation refunds after UPI cases are opened and closed through the UPI Assistant mechanism.
0719 2011-04-27	GetUserPreferencesRequestType.ShowRequiredShipPhoneNumberPreference (added): Flag used to return the RequiredShipPhoneNumberPreference in the response. GetUserPreferencesResponseType.RequiredShipPhoneNumberPreference (added): Flag to indicate whether the seller is requiring the buyer to supply a shipping phone number.
0685 2010-07-09	SellerThirdPartyCheckoutDisabled (added): This field is returned if it is set with the SetUserPreferences call. 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.
0681 2010-08-04	ShowUnpaidItemAssistanceExclusionList (added): Sellers can obtain their list of eBay user IDs on the Unpaid Item Assistance Excluded User list. For excluded users, an Unpaid Item dispute is not automatically filed through the UPI Assistance mechanism.
0637 2009-09-30	UnpaidItemAssistancePreferences (added): Sellers can now set their preference for the Unpaid Item Assistance mechanism.
0635 2009-09-16	ShowSellerExcludeShipToLocationPreference (added): Sellers can exclude specific regions and countries from where they will ship items. 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.
0601 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.
0509 2007-04-18	CombinedPaymentPreferences (modified): Modified text to mention that developers should not use this field.
0499 2007-02-07	eBxOptInPreference, ShoweBxOptInPreference (modified): Deleted previously deprecated objects from the latest schema. Some of these objects are still supported with lower request versions. 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.
0469 2006-07-12	DefaultPayPalAccount (added): A PayPal account (email address) to use for eBay Express payments during checkout. German users only.

ShowBidderNoticePreferences	boolean	Optional	If included and set to `true`, the seller's preference for receiving contact information for unsuccessful bidders is returned in the response. Default: false.
ShowCombinedPaymentPreferences	boolean	Optional	If included and set to `true`, the seller's combined invoice preferences are returned in the response. These preferences are used to allow Combined Invoice orders. Default: false. See Combined invoice.
ShowDispatchCutoffTimePreferences	boolean	Optional	If included and set to `true`, the seller's same-day handling cutoff time is returned in DispatchCutoffTimePreference.CutoffTime. Note: For sellers opted in to the feature that supports different order cutoff times for each business day, the order cutoff time returned in the response may not be accurate. In order for the seller to confirm the actual order cutoff time for same-day handling, that seller should view Shipping Preferences in My eBay. Default: false. See Same day handling for details about dispatch cut off times.
ShoweBayPLUSPreference	boolean	Optional	To determine whether a seller can offer eBay Plus in qualified listings, include this field and set it to `true`. eBay Plus is a premium account option for buyers, which provides benefits such as fast free domestic shipping and free returns on selected items. Top Rated eBay sellers must opt in to eBay Plus, and can offer the program on a per-listing basis. The eBayPLUSPreference container is returned in the response with information about each country where the seller is eligible to offer eBay Plus on listings (one eBayPLUSPreference container per country), as well as the seller's opt-in status and listing preference for each country. Note: Currently, eBay Plus is available only to buyers in Germany and Australia. In Australia, the seller has no control/responsibility over setting the eBay Plus feature for a listing. Instead, eBay will evaluate/determine whether a listing is eligible for eBay Plus. Default: false. See eBay Plus for more details.
ShowEmailShipmentTrackingNumberPreference	boolean	Optional	If included and set to `true`, the seller's preference for sending an email to the buyer with the shipping tracking number is returned in the response. Default: false.
ShowEndOfAuctionEmailPreferences	boolean	Optional	If included and set to `true`, the seller's preferences for the end-of-auction email sent to the winning bidder is returned in the response. These preferences are only applicable for auction listings. Default: false.
ShowGlobalShippingProgramListingPreference	boolean	Optional	If included and set to `true`, the GlobalShippingProgramListingPreference field is returned. A returned value of `true` indicates that the seller's new listings will enable the Global Shipping Program by default. Default: false.
ShowGlobalShippingProgramPreference	boolean	Optional	If this flag is included and set to `true`, the seller's preference for offering the Global Shipping Program to international buyers will be returned in OfferGlobalShippingProgramPreference. Default: false.
ShowOutOfStockControlPreference	boolean	Optional	If included and set to `true`, the seller's preferences related to the Out-of-Stock feature will be returned. This feature is set using the SetUserPreferences call. Default: false. See Out-of-Stock control.
ShowOverrideGSPServiceWithIntlServicePreference	boolean	Optional	If included and set to `true`, the OverrideGSPServiceWithIntlServicePreference field is returned. A returned value of `true` indicates that for the seller's listings that specify an international shipping service for any Global Shipping-eligible country, the specified service will take precedence and be the listing's default international shipping option for buyers in that country, rather than the Global Shipping Program. A returned value of `false` indicates that the Global Shipping program will take precedence over any international shipping service as the default option in Global Shipping-eligible listings for shipping to any Global Shipping-eligible country. Default: false.
ShowPickupDropoffPreferences	boolean	Optional	If included and set to `true`, the PickupDropoffSellerPreference field is returned. A returned value of `true` indicates that the seller's new listings will by default be eligible to be evaluated for the Click and Collect feature. With the Click and Collect feature, a buyer can purchase certain items on eBay and collect them at a local store. Buyers are notified by eBay once their items are available. The Click and Collect feature is only available to large merchants on the eBay UK (site ID 3), eBay Australia (Site ID 15), and eBay Germany (Site ID 77) sites. Note: The Click and Collect program no longer allows sellers to set the Click and Collect preference at the listing level. Default: false.
ShowPurchaseReminderEmailPreferences	boolean	Optional	If included and set to `true`, the seller's preference for sending a purchase reminder email to buyers is returned in the response. Default: false.
ShowRequiredShipPhoneNumberPreference	boolean	Optional	If included and set to `true`, the seller's preference for requiring that the buyer supply a shipping phone number upon checkout is returned in the response. Some shipping carriers require the receiver's phone number. Default: false.
ShowSellerExcludeShipToLocationPreference	boolean	Optional	If included and set to `true`, all of the seller's excluded shipping locations are returned in the response. The returned list mirrors the seller's current Exclude shipping locations list in My eBay's Shipping Preferences. An excluded shipping location in My eBay can be an entire geographical region (such as Middle East) or only an individual country (such as Iraq). Sellers can override these default settings for an individual listing by using the Item.ShippingDetails.ExcludeShipToLocation field in the AddItem family of calls. Default: false.
ShowSellerFavoriteItemPreferences	boolean	Optional	If included and set to `true`, the seller's favorite item preferences are returned in the response. Default: false.
ShowSellerPaymentPreferences	boolean	Optional	If included and set to `true`, the seller's payment preferences are returned in the response. Default: false.
ShowSellerProfilePreferences	boolean	Optional	If this flag is included and set to `true`, the seller's Business Policies profile information is returned in the response. This information includes a flag that indicates whether or not the seller has opted into Business Policies, as well as Business Policies profiles (payment, shipping, and return policy) active on the seller's account. Default: false.
ShowSellerReturnPreferences	boolean	Optional	If this flag is included and set to `true`, the SellerReturnPreferences container is returned in the response and indicates whether or not the seller has opted in to eBay Managed Returns. eBay Managed Returns are currently only available on the US, UK, DE, AU, and CA (English and French) sites. Default: false.
ShowUnpaidItemAssistanceExclusionList	boolean	Optional	If included and set to `true`, the list of eBay user IDs on the Unpaid Item preferences Excluded User list is returned through the UnpaidItemAssistancePreferences.ExcludedUser field in the response. For excluded users, an Unpaid Item is not automatically cancelled. The Excluded User list is managed through the SetUserPreferences call. Note: To return the list of buyers excluded from the Unpaid Item preferences, the ShowUnpaidItemAssistancePreference field must also be included and set to true in the request. Default: false.
ShowUnpaidItemAssistancePreference	boolean	Conditional	If included and set to `true`, the seller's Unpaid Item preferences are returned in the response. The Unpaid Item preferences can be used to automatically cancel an unpaid order and relist the item on the behalf of the seller. Note: To return the list of buyers excluded from the Unpaid Item preferences, the ShowUnpaidItemAssistanceExclusionList field must also be included and set to `true` in the request. Excluded buyers can be viewed in the UnpaidItemAssistancePreferences.ExcludedUser field. Default: false.