eBay Trading API891

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 Managing User Preferences.

See also the reference documentation for this call:



Back to top

GetUserPreferences Input

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

See also Samples.

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

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

<?xml version="1.0" encoding="utf-8"?>
<GetUserPreferencesRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Input Fields -->
  <ShowBidderNoticePreferences> boolean </ShowBidderNoticePreferences>
  <ShowCombinedPaymentPreferences> boolean </ShowCombinedPaymentPreferences>
  <ShowCrossPromotionPreferences> boolean </ShowCrossPromotionPreferences>
  <ShowDispatchCutoffTimePreferences> boolean </ShowDispatchCutoffTimePreferences>
  <ShowEmailShipmentTrackingNumberPreference> boolean </ShowEmailShipmentTrackingNumberPreference>
  <ShowEndOfAuctionEmailPreferences> boolean </ShowEndOfAuctionEmailPreferences>
  <ShowGlobalShippingProgramListingPreference> boolean </ShowGlobalShippingProgramListingPreference>
  <ShowGlobalShippingProgramPreference> boolean </ShowGlobalShippingProgramPreference>
  <ShowOverrideGSPServiceWithIntlServicePreference> boolean </ShowOverrideGSPServiceWithIntlServicePreference>
  <ShowPickupDropoffPreferences> boolean </ShowPickupDropoffPreferences>
  <ShowProStoresPreferences> boolean </ShowProStoresPreferences>
  <ShowPurchaseReminderEmailPreferences> boolean </ShowPurchaseReminderEmailPreferences>
  <ShowRequiredShipPhoneNumberPreference> boolean </ShowRequiredShipPhoneNumberPreference>
  <ShowSellerExcludeShipToLocationPreference> boolean </ShowSellerExcludeShipToLocationPreference>
  <ShowSellerFavoriteItemPreferences> boolean </ShowSellerFavoriteItemPreferences>
  <ShowSellerPaymentPreferences> boolean </ShowSellerPaymentPreferences>
  <ShowSellerProfilePreferences> boolean </ShowSellerProfilePreferences>
  <ShowSellerReturnPreferences> boolean </ShowSellerReturnPreferences>
  <ShowUnpaidItemAssistanceExclusionList> boolean </ShowUnpaidItemAssistanceExclusionList>
  <ShowUnpaidItemAssistancePreference> boolean </ShowUnpaidItemAssistancePreference>
  <!-- Standard Input Fields -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
</GetUserPreferencesRequest>
Argument Type Occurrence Meaning
Call-specific Input Fields [Jump to standard fields]
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 payment preferences are returned in the response. These preferences are used to allow Combined Invoice orders.

Note: The CombinedPaymentPreferences.CombinedPaymentOption field is the only preference that should be managed with the GetUserPreferences and SetUserPreferences calls. All other combined payment preferences should be managed with the SetDiscountProfiles and GetDiscountProfiles calls.
Default: false.

See Combined Invoice.

ShowCrossPromotionPreferences boolean Optional This container should no longer be used as eBay Store Cross Promotions are no longer supported in the Trading API. This container will be removed from the Trading WSDL and API Call Reference docs in a future release.

If included and set to true, the seller's cross-promotion preferences are returned in the response. These preferences are only applicable for eBay Store owners.
Default: false.
ShowDispatchCutoffTimePreferences boolean Optional If this flag is included and set to true, the seller's same day handling cut off time is returned in DispatchCutoffTimePreference.CutoffTime.
Default: false.

See Specifying Shipping Services for details about dispatch cut off times.

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 this flag is 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.
ShowOverrideGSPServiceWithIntlServicePreference boolean Optional If this flag is 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 this flag is included and set to true, the PickupDropoffSellerPreference field is returned. A returned value of true indicates that the seller's new listings will enable the Click and Collect feature by default. 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 UK sellers.
Default: false.
ShowProStoresPreferences boolean Optional If included and set to true, the seller's ProStores preferences are returned in the response.
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 site; however, eBay Managed Returns will start ramping up for UK sellers in late September 2013.
Default: false.
ShowUnpaidItemAssistanceExclusionList boolean Optional If included and set to true, the list of eBay user IDs on the Unpaid Item Assistant Excluded User list is returned through the UnpaidItemAssistancePreferences.ExcludedUser field in the response. For excluded users, an Unpaid Item dispute is not automatically filed through the UPI Assistance mechanism. The Excluded User list is managed through the SetUserPreferences call.

Note: To return the list of buyers excluded from the Unpaid Item Assistant mechanism, the ShowUnpaidItemAssistancePreference field must also be included and set to true in the request.
Default: false.
ShowUnpaidItemAssistancePreference boolean Optional If included and set to true, the seller's Unpaid Item Assistant preferences are returned in the response. The Unpaid Item Assistant automatically opens an Unpaid Item dispute on the behalf of the seller.

Note: To return the list of buyers excluded from the Unpaid Item Assistant mechanism, the ShowUnpaidItemAssistanceExclusionList field must also be included and set to true in the request. Excluded buyers can be viewed in the UnpaidItemAssistancePreferences.ExcludedUser field.
Default: false.
Standard Input Fields  
ErrorLanguage string Optional Use ErrorLanguage to return error strings for the call in a different language from the language commonly associated with the site that the requesting user is registered with. Specify the standard RFC 3066 language identification tag (e.g., en_US).

ID Country
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

See Tags for the Identification of Languages.

MessageID string Optional Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned.

Note: GetCategories is designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
Version string Conditional The version number of the API code that you are programming against (e.g., 859). The version you specify for a call has these basic effects:
- It indicates the version of the code lists and other data that eBay should use to process your request.
- It indicates the schema version you are using.
You need to use a version that is greater than or equal to the lowest supported version.

For the SOAP API: If you are using the SOAP API, this field is required. Specify the version of the WSDL your application is using.

For the XML API: If you are using the XML API, this field has no effect. Instead, specify the version in the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header. (If you specify Version in the body of an XML API request and it is different from the value in the HTTP header, eBay returns an informational warning that the value in the HTTP header was used instead.)

See:
    Routing the Request (Gateway URLs)
    eBay Schema Versioning Strategy
    Lowest Supported Version

WarningLevel WarningLevelCodeType Optional Controls whether or not to return warnings when the application passes unrecognized or deprecated elements in a request.

An unrecognized element is one that is not defined in any supported version of the schema. Schema element names are case-sensitive, so using WarningLevel can also help you remove any potential hidden bugs within your application due to incorrect case or spelling in field names before you put your application into the Production environment.

WarningLevel only validates elements; it doesn't validate XML attributes. It also doesn't control warnings related to user-entered strings or numbers, or warnings for logical errors.

We recommend that you only use this during development and debugging. Do not use this in requests performed in the Production environment.

Applicable values:

High
(in) Return warnings when the application passes unrecognized or deprecated elements in a request.
Low
(in) Do not return warnings when the application passes unrecognized or deprecated elements in a request. This is the default value if WarningLevel is not specified.

See Warning Level.



Back to top

GetUserPreferences Output

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

See also Samples.

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>
  <CrossPromotionPreferences> CrossPromotionPreferencesType
    <CrossPromotionEnabled> boolean </CrossPromotionEnabled>
    <CrossSellGallerySortFilter> GallerySortFilterCodeType </CrossSellGallerySortFilter>
    <CrossSellItemFormatSortFilter> ItemFormatSortFilterCodeType </CrossSellItemFormatSortFilter>
    <CrossSellItemSortFilter> ItemSortFilterCodeType </CrossSellItemSortFilter>
    <UpSellGallerySortFilter> GallerySortFilterCodeType </UpSellGallerySortFilter>
    <UpSellItemFormatSortFilter> ItemFormatSortFilterCodeType </UpSellItemFormatSortFilter>
    <UpSellItemSortFilter> ItemSortFilterCodeType </UpSellItemSortFilter>
  </CrossPromotionPreferences>
  <DispatchCutoffTimePreference> DispatchCutoffTimePreferencesType
    <CutoffTime> time </CutoffTime>
  </DispatchCutoffTimePreference>
  <EmailShipmentTrackingNumberPreference> boolean </EmailShipmentTrackingNumberPreference>
  <EndOfAuctionEmailPreferences> EndOfAuctionEmailPreferencesType
    <CopyEmail> boolean </CopyEmail>
    <EmailCustomized> boolean </EmailCustomized>
    <LogoCustomized> boolean </LogoCustomized>
    <LogoType> EndOfAuctionLogoTypeCodeType </LogoType>
    <LogoURL> anyURI </LogoURL>
    <TemplateText> string </TemplateText>
    <TextCustomized> boolean </TextCustomized>
  </EndOfAuctionEmailPreferences>
  <GlobalShippingProgramListingPreference> boolean </GlobalShippingProgramListingPreference>
  <OfferGlobalShippingProgramPreference> boolean </OfferGlobalShippingProgramPreference>
  <OverrideGSPServiceWithIntlServicePreference> boolean </OverrideGSPServiceWithIntlServicePreference>
  <PickupDropoffSellerPreference> boolean </PickupDropoffSellerPreference>
  <ProStoresPreference> ProStoresCheckoutPreferenceType </ProStoresPreference>
  <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 </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>
  <SellerThirdPartyCheckoutDisabled> boolean </SellerThirdPartyCheckoutDisabled>
  <UnpaidItemAssistancePreferences> UnpaidItemAssistancePreferencesType
    <AutoOptDonationRefund> boolean </AutoOptDonationRefund>
    <AutoRelist> boolean </AutoRelist>
    <DelayBeforeOpeningDispute> int </DelayBeforeOpeningDispute>
    <ExcludedUser> string </ExcludedUser>
    <!-- ... more ExcludedUser values allowed here ... -->
    <OptInStatus> boolean </OptInStatus>
    <RemoveAllExcludedUsers> boolean </RemoveAllExcludedUsers>
  </UnpaidItemAssistancePreferences>
  <!-- Standard 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 If true, sends the seller a notice containing the contact information for unsuccessful bidders.
CombinedPaymentPreferences CombinedPaymentPreferencesType Conditionally Container consisting of the seller's combined payment 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.

Note: Calculated and flat-rate shipping preferences are no longer managed using the SetUserPreferences and GetUserPreferences calls. Instead, use the SetDiscountProfiles and GetDiscountProfiles calls to manage shipping discounts for Combined Invoice orders.
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.

See Combined Invoice.

CrossPromotionPreferences CrossPromotionPreferencesType Conditionally This container is no longer supported 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.
CrossPromotionPreferences
  .CrossPromotionEnabled
boolean Conditionally (For eBay store owners only) Specifies whether cross-promotions are enabled for the seller's listings.

Note: This field should no longer be used as eBay Store Cross Promotions are no longer supported in the Trading API.
CrossPromotionPreferences
  .CrossSellGallerySortFilter
GallerySortFilterCodeType Conditionally (For eBay store owners only) Specifies whether to display only items with gallery images and whether they should precede other items in cross-sell promotions.

Note: This field should no longer be used as eBay Store Cross Promotions are no longer supported in the Trading API.

Applicable values:

CustomCode
(in/out) Reserved for internal or future use.
ShowAnyItems
(in/out) Show any items, in no particular order.
ShowItemsWithGalleryImagesFirst
(in/out) Show items with gallery images first, before other items.
ShowOnlyItemsWithGalleryImages
(in/out) Show only items with gallery images.

CrossPromotionPreferences
  .CrossSellItemFormatSortFilter
ItemFormatSortFilterCodeType Conditionally (For eBay store owners only) Specifies which items should be shown in cross-sell promotions (such as Buy It Now) and in which sequence.

Note: This field should no longer be used as eBay Store Cross Promotions are no longer supported in the Trading API.

Applicable values:

CustomCode
(in/out) Reserved for internal or future use.
ShowAnyItems
(in/out) Show any items, in no particular order.
ShowItemsWithBINFirst
(in/out) Show items with a Buy It Now price first.
ShowOnlyItemsWithBIN
(in/out) Show only items with a Buy It Now price.
ShowOnlyStoreItems
(in/out) Used for Store Inventory listings, which are no longer supported on any eBay site.

CrossPromotionPreferences
  .CrossSellItemSortFilter
ItemSortFilterCodeType Conditionally (For eBay store owners only) Specifies how to sort items displayed in a cross-sell promotion.

Note: This field should no longer be used as eBay Store Cross Promotions are no longer supported in the Trading API.

Applicable values:

CustomCode
(in/out) Reserved for internal or future use.
EndingLast
(in/out) Sort items by ending time, with items ending last first.
EndingSoonest
(in/out) Sort items by ending time, with items ending soonest first.
HighestPrice
(in/out) Sort items by price, with the highest price first.
LowestPrice
(in/out) Sort items by price, with the lowest price first.
NewlyListed
(in/out) Sort items by listing time, with newly listed items first.
RandomlySelected
(in/out) Sort items in a randomly selected order.

CrossPromotionPreferences
  .UpSellGallerySortFilter
GallerySortFilterCodeType Conditionally (For eBay store owners only) Specifies whether to display only items with gallery images in upsell promotions and whether they should precede other items.

Note: This field should no longer be used as eBay Store Cross Promotions are no longer supported in the Trading API.

Applicable values:

CustomCode
(in/out) Reserved for internal or future use.
ShowAnyItems
(in/out) Show any items, in no particular order.
ShowItemsWithGalleryImagesFirst
(in/out) Show items with gallery images first, before other items.
ShowOnlyItemsWithGalleryImages
(in/out) Show only items with gallery images.

CrossPromotionPreferences
  .UpSellItemFormatSortFilter
ItemFormatSortFilterCodeType Conditionally (For eBay store owners only) Specifies which items (such as Buy It Now) should be shown in upsell promotions and in which sequence.

Note: This field should no longer be used as eBay Store Cross Promotions are no longer supported in the Trading API.

Applicable values:

CustomCode
(in/out) Reserved for internal or future use.
ShowAnyItems
(in/out) Show any items, in no particular order.
ShowItemsWithBINFirst
(in/out) Show items with a Buy It Now price first.
ShowOnlyItemsWithBIN
(in/out) Show only items with a Buy It Now price.
ShowOnlyStoreItems
(in/out) Used for Store Inventory listings, which are no longer supported on any eBay site.

CrossPromotionPreferences
  .UpSellItemSortFilter
ItemSortFilterCodeType Conditionally (For eBay store owners only) Specifies how to sort items used in an upsell promotion.

Note: This field should no longer be used as eBay Store Cross Promotions are no longer supported in the Trading API.

Applicable values:

CustomCode
(in/out) Reserved for internal or future use.
EndingLast
(in/out) Sort items by ending time, with items ending last first.
EndingSoonest
(in/out) Sort items by ending time, with items ending soonest first.
HighestPrice
(in/out) Sort items by price, with the highest price first.
LowestPrice
(in/out) Sort items by price, with the lowest price first.
NewlyListed
(in/out) Sort items by listing time, with newly listed items first.
RandomlySelected
(in/out) Sort items in a randomly selected order.

DispatchCutoffTimePreference DispatchCutoffTimePreferencesType Conditionally Contains information about a seller's order cut off time preferences for same-day shipping. If the seller specifies a value of '0' in Item.DispatchTimeMax to offer same-day handling when listing an item, the seller's shipping time commitment depends on the order cut off time set for the listing site, as indicated by DispatchCutoffTimePreference.CutoffTime.

See Specifying Shipping Services.

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: If a same day shipping carrier is selected, and the carrier delivers on one or both weekend days, sellers on the eBay US site are assumed to be open for business on the same days, and those days will be used when calculating total shipping time. CutoffTime has a default initial value for each eBay site, but you can use SetUserPreferences to override the default for individual sellers. The default value for most eBay sites is 2:00PM local time. Enter times in 30 minute increments from the top of the hour. That is, enter values either on the hour (:00) or 30 minutes past the hour (:30). Other values will be rounded down to the next closest 30 minute increment. Times entered should be local to the value provided for TimeZoneID.

See Specifying Shipping Services for details about dispatch cut off times.

EmailShipmentTrackingNumberPreference boolean 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
  .CopyEmail
boolean Conditionally Deprecated as of version 889. No longer functional.
This field is non-operational and will always be set to false. Indicates whether or not the seller wishes to receive a copy of the customized email sent to the winning buyer.
Deprecation version: 889. See also Deprecated Objects.
EndOfAuctionEmailPreferences
  .EmailCustomized
boolean Conditionally Indicates whether or not the seller wishes to send a customized email to winning buyers.
EndOfAuctionEmailPreferences
  .LogoCustomized
boolean Conditionally Indicates whether or not the seller wishes to include a logo in the customized email.
EndOfAuctionEmailPreferences
  .LogoType
EndOfAuctionLogoTypeCodeType Conditionally The type of logo to include in the customized email.

Applicable values:

CustomCode
(in/out) Reserved for internal or future use.
Customized
(in/out) A custom logo specified in LogoURL.
None
(out) Indicates that no logo has been specified for use in the end of auction (EOA) email.
Store
(in/out) The seller's eBay Store logo.
WinningBidderNotice
(in/out) The PayPal Winning Bidder Notice logo.

EndOfAuctionEmailPreferences
  .LogoURL
anyURI Conditionally The URL of the logo to include in the customized email.
EndOfAuctionEmailPreferences
  .TemplateText
string Conditionally The text of the custom message for the email.
EndOfAuctionEmailPreferences
  .TextCustomized
boolean Conditionally Indicates whether or not the text of the customized message will be customized.
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'.
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 response. 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 enable the Click and Collect feature by default. 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 UK sellers.
ProStoresPreference ProStoresCheckoutPreferenceType Conditionally Container consisting of the seller's ProStores preferences. This container is returned when ShowProStoresPreference is included and set to 'true' in the request.
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 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, "http://www.iso.org/iso/country_codes/iso_3166_code_lists/english_country_names_and_code_elements.htm">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 DetailName set to ExcludeShippingLocationDetails. Repeat GeteBayDetails for each site on which you list.

Note: To enable your default Exclude Ship-To List, you must enable Exclude Shipping Locations and Buyer Requirements in your My eBay Site Preferences. For details, see the KnowledgeBase Article HowTo: ExcludeShipToLocation. Code denoting a location to where the seller will not ship.
The codes reflect the ISO 3166 location codes.
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) An optional input parameter used with GetMyeBaySelling. When used in the request, returns items of competitive-bid auctions.
FixedPriceItem
(in/out) A basic fixed-price item format. Bids do not occur. The quantity of items is one or more.

Also known as Buy It Now Only on some sites (not to be confused with the BuyItNow option that is available for auctions).

Sellers must meet certain feedback requirements and/or be ID Verified to use this format. See eBay Features Guide for more information.

Fixed-price listings are listed on eBay.com, and they are listed in the seller's eBay Store if the seller is a Store owner. Stores fixed price items will be treated as basic fixed-price items. Permitted durations of 30 days and GTC are now available for store and non-store subscribers (in addition to the existing durations of 3, 5, 7, and 10 days).
LeadGeneration
(in/out) Lead Generation format (advertisement-style listing to solicit inquiries or offers, no bidding or fixed price, listed on eBay).

(Not all values in ListingTypeCodeType apply to this field.)
SellerFavoriteItemPreferences
  .MaxPrice
AmountType (double) 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:

CustomCode
(in/out) Reserved for internal or future use.
EndingFirst
(in/out) Lists items with those ending soon listed first.
HighestPriced
(in/out) Lists items by price in descending order. The item with the highest starting price is listed first.
HighestPricedPlusShipping
(in/out) Reserved for future use. Lists items by combined price and shipping cost in descending order. The item with the highest combined starting price plus shipping cost is listed first.
LowestPriced
(in/out) Lists items by price in ascending order. The item with the lowest starting price is listed first.
LowestPricedPlusShipping
(in/out) Lists items by combined price and shipping cost in ascending order. The item with the lowest combined starting price plus shipping cost is listed first.
NewlyListed
(in/out) Lists items with those newly listed appearing in the list first.

SellerFavoriteItemPreferences
  .StoreCategoryID
long 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 item's category allows offline payments, and the seller has allowed the buyer to mail a payment. This payment address will only be displayed to winning bidders and buyers.
SellerPaymentPreferences
  .DefaultPayPalEmailAddress
string Conditionally Specifies the default email address the seller uses for receiving PayPal payments.
SellerPaymentPreferences
  .DisplayPayNowButton
DisplayPayNowButtonCodeType Conditionally If set, this field determines whether a Pay Now button is displayed for all of the user's listings. The user has the option of using a PayPal only version of the Pay Now button or a Pay Now button for all payment methods.

Applicable values:

CustomCode
(in/out) Reserved for internal or future use
ShowPayNowButtonForAllPaymentMethods
(in/out) Show PayNow Button For All Payment Methods
ShowPayNowButtonForPayPalOnly
(in/out) Show PayNow Button For PayPal Only

SellerPaymentPreferences
  .FedExRateOption
FedExRateOptionCodeType Conditionally Specifies the type of FedEx rates to use.

Applicable values:

CustomCode
(in/out) Reserved for internal or future use
FedExCounter
(in/out) FedEx Counter Rates
FedExDiscounted
(in/out) FedEx Discounted Rates
FedExStandardList
(in/out) FedEx Standard List Rates

SellerPaymentPreferences
  .PayPalAlwaysOn
boolean Conditionally Indicates whether PayPal is always accepted for the seller's listings.
SellerPaymentPreferences
  .PayPalPreferred
boolean Conditionally Specifies whether a seller wants to let buyers know that PayPal payments are preferred.
SellerPaymentPreferences
  .SellerPaymentAddress
AddressType Conditionally Specifies the address the seller uses to receive mailed payments from 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.

For a Global Shipping Program order, GetSellerList returns the country code of the buyer, not the international shipping provider.

Also applicable to Half.com (for GetOrders).

Applicable values: See Country.
SellerPaymentPreferences
  .UPSRateOption
UPSRateOptionCodeType Conditionally Specifies the type of United Parcel Service rates to use.

Applicable values:

CustomCode
(in/out) Reserved for internal or future use
UPSDailyRates
(in/out) UPS Daily Rates
UPSOnDemandRates
(in/out) UPS On-Demand Rates

SellerPaymentPreferences
  .USPSRateOption
USPSRateOptionCodeType Conditionally Specifies the type of USPS rates to use.

Applicable values:

CustomCode
(in/out) Reserved for internal or future use
USPSDiscounted
(in/out) USPS Discounted
USPSRetail
(in/out) USPS Retail

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=true 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 Identifies that 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.

eBay Managed returns are currently only available on the US site; however, eBay Managed Returns will start ramping up for UK sellers in late September 2013.
SellerThirdPartyCheckoutDisabled boolean Conditionally This flag is set with the SellerThirdPartyCheckoutDisabled field of the SetUserPreferences call, and is used to disable the use of a third-party application to handle the checkout flow for a seller. If true, Third-Party Checkout is disabled and any checkout flow initiated on the seller's application is redirected to the eBay checkout flow. This field is only returned if the SellerThirdPartyCheckoutDisabled field has been set with the SetUserPreferences call.
UnpaidItemAssistancePreferences UnpaidItemAssistancePreferencesType Conditionally Container consisting of a seller's Unpaid Item Assistant preferences. The Unpaid Item Assistant automatically opens an Unpaid Item dispute on the behalf of the seller. This container is returned if ShowUnpaidItemAssistancePreference is included and set to 'true' in the request.

Note: To return the list of buyers excluded from the Unpaid Item Assistant mechanism, the ShowUnpaidItemAssistanceExclusionList field must also be included and set to 'true' in the request. Excluded buyers can be viewed in the UnpaidItemAssistancePreferences.ExcludedUser field.
UnpaidItemAssistancePreferences
  .AutoOptDonationRefund
boolean Conditionally Flag to indicate whether or not the seller wants eBay to automatically request eBay Giving Works donation refunds after Unpaid Item cases are opened and closed through the Unpaid Item Assistant mechanism without payment. This setting is only applicable to eBay Charity listings. This field is ignored if the OptInStatus flag is included and set to false in the request, or if the seller is not currently opted into the Unpaid Item Assistant feature in Unpaid Item Assistant Preferences on My eBay.
UnpaidItemAssistancePreferences
  .AutoRelist
boolean Conditionally Flag to indicate whether or not the seller wants eBay to automatically relist items after corresponding Unpaid Item cases are opened and closed through the Unpaid Item Assistant mechanism without payment. For a multi-quantity listing, the quantity is adjusted if AutoRelist is set to true. This field is ignored if the OptInStatus flag is included and set to false in the request, or if the seller is not currently opted into the Unpaid Item Assistant feature in Unpaid Item Assistant Preferences on My eBay.
UnpaidItemAssistancePreferences
  .DelayBeforeOpeningDispute
int Conditionally This value indicates the number of days that should elapse before the Unpaid Item Assistant mechanism opens an Unpaid Item case on behalf of the seller. Valid values for this field are: 2, 4, 8, 16, 24, and 32 (days). This field is ignored if the OptInStatus flag is included and set to false in the request, or if the seller is not currently opted into the Unpaid Item Assistant feature in Unpaid Item Assistant Preferences on My eBay.
Min: 2. Max: 32. Default: 32.
UnpaidItemAssistancePreferences
  .ExcludedUser
string Conditionally,
repeatable: [0..*]
An eBay User ID for which the Unpaid Item Assistant mechanism is disabled. This field is typically used by a seller who would prefer to file an Unpaid Item dispute manually for the specified user.

One or more ExcludedUser fields are used in SetUserPreferences to add users to Unpaid Item Assistant Exclusion list. Any and all ExcludedUser fields are ignored if the OptInStatus flag is included and set to false in the request, or if the seller is not currently opted into the Unpaid Item Assistant feature in Unpaid Item Assistant Preferences on My eBay.

In GetUserPreferences, one or more ExcludedUser fields represent the current Excluded user list.
UnpaidItemAssistancePreferences
  .OptInStatus
boolean Conditionally Flag to indicate whether or not the Unpaid Item Assistant mechanism is turned on for the seller. Through the Unpaid Item Assistant mechanism, eBay can automatically file Unpaid Item cases on behalf of the seller. The Unpaid Item Assistant feature also has options to automatically relist disputed items, to automatically request a Giving Works donation refund (for Charity listings only), or to create an 'Exclusion list' of buyers who are not subject to the automatic filing of an Unpaid Item case.
UnpaidItemAssistancePreferences
  .RemoveAllExcludedUsers
boolean Conditionally This field should be included and set to true if the seller wants to clear all users from the Unpaid Item Assistant Exclusion list. The Exclusion list can be viewed from the Unpaid Item Assistant Preferences in My eBay. Excluded users are not subject to the automatic filing of Unpaid Item cases. The seller can still open Unpaid Item cases against excluded users, but these cases must be opened manually.

Users can be added to Exclusion list through the ExcludedUser field. The RemoveAllExcludedUsers field is ignored if the OptInStatus flag is included and set to false in the request, or if the seller is not currently opted into the Unpaid Item Assistant feature in Unpaid Item Assistant Preferences on My eBay.
Standard 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) Request processing failed
Success
(out) Request processing succeeded
Warning
(out) Request processing completed with warning information being included in the response message

(Not all values in AckCodeType apply to this field.)
Build string Always This refers to the specific software build that eBay used when processing the request and generating the response. This includes the version number plus additional information. eBay Developer Support may request the build information when helping you resolve technical issues.
CorrelationID string Conditionally Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned.

Note: GetCategories is designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
Errors ErrorType Conditionally,
repeatable: [0..*]
A list of application-level errors (if any) that occurred when eBay processed the request.

See Error Handling.

Errors.ErrorClassification ErrorClassificationCodeType Conditionally API errors are divided between two classes: system errors and request errors.

Applicable values:

CustomCode
(out) Reserved for internal or future use.
RequestError
(out) An error has occurred either as a result of a problem in the sending application or because the application's end-user has attempted to submit invalid data (or missing data). In these cases, do not retry the request. The problem must be corrected before the request can be made again. If the problem is due to something in the application (such as a missing required field), the application must be changed. If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the application or data is resolved, resend the request to eBay with the corrected data.
SystemError
(out) Indicates that an error has occurred on the eBay system side, such as a database or server down. An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.

Errors.ErrorCode token Conditionally A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms. See the "Errors by Number" document.
Errors.ErrorParameters ErrorParameterType Conditionally,
repeatable: [0..*]
This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned.
Errors.ErrorParameters
  [ attribute ParamID ]
string Conditionally 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 The value of the variable (e.g., the attribute set ID)
Errors.LongMessage string Conditionally A more detailed description of the condition that raised the error.
Errors.SeverityCode SeverityCodeType Conditionally Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user.

Applicable values:

CustomCode
(out) Reserved for internal or future use.
Error
(out) 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 Compatible Application Check section of the eBay Features 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.

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.



Back to top

GetUserPreferences Detail Controls


DetailLevel

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



Back to top

GetUserPreferences Samples

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

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

Sample: Basic Call

Gets the settings for a specified set of user preferences.

Description

Magical Bookseller wants to check her user preference settings.

Input

Magical Bookseller wants to review her 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 (HTTP POST). Also available are the .txt version of this XML.

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

Output

XML format.
<GetUserPreferencesResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2010-01-20T19:19:44.355Z</Timestamp>
  <Ack>Success</Ack>
  <Version>643</Version>
  <Build>E643_CORE_BUNDLED_10284414_R1</Build>
  <BidderNoticePreferences/>
  <SellerPaymentPreferences>
    <DisplayPayNowButton>ShowPayNowButtonForAllPaymentMethods</DisplayPayNowButton>
    <PayPalPreferred>false</PayPalPreferred>
    <PayPalAlwaysOn>false</PayPalAlwaysOn>
    <UPSRateOption>UPSOnDemandRates</UPSRateOption>
  </SellerPaymentPreferences>
  <SellerExcludeShipToLocationPreferences>
    <ExcludeShipToLocation>AF</ExcludeShipToLocation>
    <ExcludeShipToLocation>AE</ExcludeShipToLocation>
    <ExcludeShipToLocation>AM</ExcludeShipToLocation>
    <ExcludeShipToLocation>AZ</ExcludeShipToLocation>
    <ExcludeShipToLocation>BD</ExcludeShipToLocation>
    <ExcludeShipToLocation>BH</ExcludeShipToLocation>
    <ExcludeShipToLocation>BN</ExcludeShipToLocation>
    <ExcludeShipToLocation>BT</ExcludeShipToLocation>
    <ExcludeShipToLocation>CN</ExcludeShipToLocation>
    <ExcludeShipToLocation>GE</ExcludeShipToLocation>
    <ExcludeShipToLocation>HK</ExcludeShipToLocation>
    <ExcludeShipToLocation>ID</ExcludeShipToLocation>
    <ExcludeShipToLocation>IN</ExcludeShipToLocation>
    <ExcludeShipToLocation>IQ</ExcludeShipToLocation>
    <ExcludeShipToLocation>IL</ExcludeShipToLocation>
    <ExcludeShipToLocation>JO</ExcludeShipToLocation>
    <ExcludeShipToLocation>JP</ExcludeShipToLocation>
    <ExcludeShipToLocation>KZ</ExcludeShipToLocation>
    <ExcludeShipToLocation>KG</ExcludeShipToLocation>
    <ExcludeShipToLocation>KH</ExcludeShipToLocation>
    <ExcludeShipToLocation>KR</ExcludeShipToLocation>
    <ExcludeShipToLocation>KW</ExcludeShipToLocation>
    <ExcludeShipToLocation>LA</ExcludeShipToLocation>
    <ExcludeShipToLocation>LB</ExcludeShipToLocation>
    <ExcludeShipToLocation>LK</ExcludeShipToLocation>
    <ExcludeShipToLocation>MO</ExcludeShipToLocation>
    <ExcludeShipToLocation>MV</ExcludeShipToLocation>
    <ExcludeShipToLocation>MN</ExcludeShipToLocation>
    <ExcludeShipToLocation>MY</ExcludeShipToLocation>
    <ExcludeShipToLocation>NP</ExcludeShipToLocation>
    <ExcludeShipToLocation>OM</ExcludeShipToLocation>
    <ExcludeShipToLocation>PK</ExcludeShipToLocation>
    <ExcludeShipToLocation>PH</ExcludeShipToLocation>
    <ExcludeShipToLocation>QA</ExcludeShipToLocation>
    <ExcludeShipToLocation>RU</ExcludeShipToLocation>
    <ExcludeShipToLocation>SA</ExcludeShipToLocation>
    <ExcludeShipToLocation>SG</ExcludeShipToLocation>
    <ExcludeShipToLocation>TH</ExcludeShipToLocation>
    <ExcludeShipToLocation>TJ</ExcludeShipToLocation>
    <ExcludeShipToLocation>TM</ExcludeShipToLocation>
    <ExcludeShipToLocation>TR</ExcludeShipToLocation>
    <ExcludeShipToLocation>TW</ExcludeShipToLocation>
    <ExcludeShipToLocation>UZ</ExcludeShipToLocation>
    <ExcludeShipToLocation>VN</ExcludeShipToLocation>
    <ExcludeShipToLocation>YE</ExcludeShipToLocation>
    <ExcludeShipToLocation>Asia</ExcludeShipToLocation>
    <ExcludeShipToLocation>Middle East</ExcludeShipToLocation>
    <ExcludeShipToLocation>Southeast Asia</ExcludeShipToLocation>
  </SellerExcludeShipToLocationPreferences>
</GetUserPreferencesResponse>



Back to top

GetUserPreferences Change History

Version Description
879
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.
849
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.
837
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.
829
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.
825
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.
817
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).
797
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.
785
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.
783
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.
763
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).
745
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.
719
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.
685
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.
681
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.
637
2009-09-30
  • UnpaidItemAssistancePreferences (added): Sellers can now set their preference for the Unpaid Item Assistance mechanism.
635
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.
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, 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.
469
2006-07-12
  • DefaultPayPalAccount (added): A PayPal account (email address) to use for eBay Express payments during checkout. German users only.



Back to top

User-Contributed Notes