GetUserPreferences

Note: The eBay Business Policies Management API and associated Trading API changes are available for testing in the Sandbox environment beginning with the Version 763 release.

In April 2012, the Business Policies Management API becomes available in the Production environment. Although actual business policies can be created using the API at this time, the policies cannot be applied to live eBay listings until May 2012.

In May 2012, the Business Policies Management API and associated Trading API fields become available in the Production environment. At this time, actual business policy profiles can be applied to live eBay listings.

Use the GetUserPreferencescall to retrieve user preferences for the authenticated caller. 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:

SetUserPreferences - Sets the authenticated user's preferences to those specified in the request.

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

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

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"?>
<GetUserPreferencesResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- 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 here ... -->
    <LongMessage> string </LongMessage>
    <SeverityCode> SeverityCodeType </SeverityCode>
    <ShortMessage> string </ShortMessage>
  </Errors>
  <!-- ... more Errors nodes here ... -->
  <HardExpirationWarning> string </HardExpirationWarning>
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
  <!-- Call-specific Output Fields -->
  <BidderNoticePreferences> BidderNoticePreferencesType
    <UnsuccessfulBidderNoticeIncludeMyItems> boolean </UnsuccessfulBidderNoticeIncludeMyItems>
  </BidderNoticePreferences>
  <CombinedPaymentPreferences> CombinedPaymentPreferencesType
    <CalculatedShippingPreferences> CalculatedShippingPreferencesType
      <CalculatedShippingAmountForEntireOrder> AmountType (double) </CalculatedShippingAmountForEntireOrder>
      <CalculatedShippingChargeOption> CalculatedShippingChargeOptionCodeType </CalculatedShippingChargeOption>
      <CalculatedShippingRateOption> CalculatedShippingRateOptionCodeType </CalculatedShippingRateOption>
      <InsuranceOption> InsuranceOptionCodeType </InsuranceOption>
    </CalculatedShippingPreferences>
    <CombinedPaymentOption> CombinedPaymentOptionCodeType </CombinedPaymentOption>
    <CombinedPaymentPeriod> CombinedPaymentPeriodCodeType </CombinedPaymentPeriod>
    <FlatShippingPreferences> FlatShippingPreferencesType
      <AmountPerAdditionalItem> AmountType (double) </AmountPerAdditionalItem>
      <DeductionAmountPerAdditionalItem> AmountType (double) </DeductionAmountPerAdditionalItem>
      <FlatRateInsuranceRangeCost> FlatRateInsuranceRangeCostType
        <FlatRateInsuranceRange> FlatRateInsuranceRangeCodeType </FlatRateInsuranceRange>
        <InsuranceCost> AmountType (double) </InsuranceCost>
      </FlatRateInsuranceRangeCost>
      <!-- ... more FlatRateInsuranceRangeCost nodes here ... -->
      <FlatShippingRateOption> FlatShippingRateOptionCodeType </FlatShippingRateOption>
      <InsuranceOption> InsuranceOptionCodeType </InsuranceOption>
    </FlatShippingPreferences>
  </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>
  <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>
  <ProStoresPreference> ProStoresCheckoutPreferenceType
    <CheckoutRedirectProStores> boolean </CheckoutRedirectProStores>
    <ProStoresDetails> ProStoresDetailsType
      <SellerThirdPartyUsername> string </SellerThirdPartyUsername>
      <Status> EnableCodeType </Status>
      <StoreName> string </StoreName>
    </ProStoresDetails>
  </ProStoresPreference>
  <PurchaseReminderEmailPreferences> PurchaseReminderEmailPreferencesType
    <PurchaseReminderEmailPreferences> boolean </PurchaseReminderEmailPreferences>
  </PurchaseReminderEmailPreferences>
  <RequiredShipPhoneNumberPreference> boolean </RequiredShipPhoneNumberPreference>
  <SellerExcludeShipToLocationPreferences> SellerExcludeShipToLocationPreferencesType
    <ExcludeShipToLocation> string </ExcludeShipToLocation>
    <!-- ... more ExcludeShipToLocation nodes here ... -->
  </SellerExcludeShipToLocationPreferences>
  <SellerFavoriteItemPreferences> SellerFavoriteItemPreferencesType
    <FavoriteItemID> ItemIDType (string) </FavoriteItemID>
    <!-- ... more FavoriteItemID nodes here ... -->
    <ListingType> ListingTypeCodeType </ListingType>
    <MaxPrice> AmountType (double) </MaxPrice>
    <MinPrice> AmountType (double) </MinPrice>
    <SearchKeywords> string </SearchKeywords>
    <SearchSortOrder> StoreItemListSortOrderCodeType </SearchSortOrder>
    <StoreCategoryID> long </StoreCategoryID>
  </SellerFavoriteItemPreferences>
  <SellerPaymentPreferences> SellerPaymentPreferencesType
    <AlwaysUseThisPaymentAddress> boolean </AlwaysUseThisPaymentAddress>
    <DefaultPayPalEmailAddress> string </DefaultPayPalEmailAddress>
    <DisplayPayNowButton> DisplayPayNowButtonCodeType </DisplayPayNowButton>
    <FedExRateOption> FedExRateOptionCodeType </FedExRateOption>
    <PayPalAlwaysOn> boolean </PayPalAlwaysOn>
    <PayPalPreferred> boolean </PayPalPreferred>
    <SellerPaymentAddress> AddressType
      <Country> CountryCodeType </Country>
    </SellerPaymentAddress>
    <UPSRateOption> UPSRateOptionCodeType </UPSRateOption>
    <USPSRateOption> USPSRateOptionCodeType </USPSRateOption>
  </SellerPaymentPreferences>
  <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 here ... -->
    </SupportedSellerProfiles>
  </SellerProfilePreferences>
  <SellerThirdPartyCheckoutDisabled> boolean </SellerThirdPartyCheckoutDisabled>
  <UnpaidItemAssistancePreferences> UnpaidItemAssistancePreferencesType
    <AutoOptDonationRefund> boolean </AutoOptDonationRefund>
    <AutoRelist> boolean </AutoRelist>
    <DelayBeforeOpeningDispute> int </DelayBeforeOpeningDispute>
    <ExcludedUser> string </ExcludedUser>
    <!-- ... more ExcludedUser nodes here ... -->
    <OptInStatus> boolean </OptInStatus>
    <RemoveAllExcludedUsers> boolean </RemoveAllExcludedUsers>
  </UnpaidItemAssistancePreferences>
</GetUserPreferencesResponse>

Return Value	Type	Occurrence	Meaning

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

Call-specific Output 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. This container is returned when ShowCombinedPaymentPreferences is included and set to true in the request. 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.
CombinedPaymentPreferences .CalculatedShippingPreferences	CalculatedShippingPreferencesType	Conditionally	DO NOT USE THIS CONTAINER. As an alternative, use SetShippingDiscountProfiles to set all Calculated Shipping rules and preferences, and use GetShippingDiscountProfiles to retrieve the same information.
CombinedPaymentPreferences .CalculatedShippingPreferences .CalculatedShippingAmountForEntireOrder	AmountType (double)	Conditionally	DO NOT USE THIS FIELD. Calculated Shipping discount profiles are created and managed with SetShippingDiscountProfiles. Use GetShippingDiscountProfiles to retrieve Calculated Shipping discount profiles.
CombinedPaymentPreferences .CalculatedShippingPreferences .CalculatedShippingChargeOption	CalculatedShippingChargeOptionCodeType	Conditionally	DO NOT USE THIS FIELD. Calculated Shipping discount profiles are created and managed with SetShippingDiscountProfiles. Use GetShippingDiscountProfiles to retrieve Calculated Shipping discount profiles. Applicable values: • ChargeEachItem (in/out) Charge the actual shipping cost and my full packaging and handling fee for each item. • ChargeEntireOrder (in/out) Charge the actual shipping cost and a packaging and handling fee of X amount for the entire order. • CustomCode (in/out) Reserved for internal or future use.
CombinedPaymentPreferences .CalculatedShippingPreferences .CalculatedShippingRateOption	CalculatedShippingRateOptionCodeType	Conditionally	DO NOT USE THIS FIELD. Calculated Shipping discount profiles are created and managed with SetShippingDiscountProfiles. Use GetShippingDiscountProfiles to retrieve Calculated Shipping discount profiles. Applicable values: • CombinedItemWeight (in/out) Calculate the Actual Shipping Rate from Combined Item Weight • CustomCode (in/out) Reserved for internal or future use. • IndividualItemWeight (in/out) Calculate the Actual Shipping Rate from Individual Item Weight
CombinedPaymentPreferences .CalculatedShippingPreferences .InsuranceOption	InsuranceOptionCodeType	Conditionally	DO NOT USE THIS FIELD. Shipping insurance parameters are passed in through SetShippingDiscountProfiles and retrieved using GetShippingDiscountProfiles. InsuranceOption is only valid on the following eBay sites: AU, FR, IT, and IN. Applicable values: • CustomCode (in/out) Reserved for internal or future use • IncludedInShippingHandling (in/out) The seller is not charging separately for shipping insurance costs; any insurance is already included in the base shipping cost. • NotOffered (in/out) The seller does not offer shipping insurance to the buyer. • NotOfferedOnSite (out) Shipping insurance is not offered as a separate option on the site where the item is listed. (Some shipping services, such as DE_InsuredExpressOrCourier, include insurance as part of the service.) If another insurance option is specified in the listing request and the site does not support shipping insurance as a separate option, eBay will reset the insurance option to this value. At the time of this writing, this option is only meaningful for the eBay Germany, Austria, and Switzerland sites. • Optional (in/out) The seller offers the buyer the choice of paying for shipping insurance or not. • Required (in/out) The seller requires that the buyer pay for shipping insurance.
CombinedPaymentPreferences .CombinedPaymentOption	CombinedPaymentOptionCodeType	Conditionally	Specifies whether or not a seller wants to allow buyers to combine single order line items into a Combined Payment order. A Combined Payment order can be created by the buyer or seller if multiple unpaid order line items exist between the same buyer and seller. Often, a Combined Payment order can reduce shipping and handling expenses for the buyer and seller. Applicable values: • CustomCode (in/out) Reserved for internal or future use. • DiscountSpecified (in/out) Yes. Specify discount now. • NoCombinedPayment (in/out) Combined payments are not allowed by seller. • SpecifyDiscountLater (in/out) Yes. Specify discount later.
CombinedPaymentPreferences .CombinedPaymentPeriod	CombinedPaymentPeriodCodeType	Conditionally	DO NOT USE THIS FIELD. As an alternative, use the CombinedDuration field in SetShippingDiscountProfiles to specify the time period in which to allow buyers to combine order line items into a Combined Payment order. Use GetShippingDiscountProfiles to retrieve the CombinedDuration value. Applicable values: • CustomCode (in/out) Reserved for internal or future use • Days_3 (in/out) 3 days • Days_5 (in/out) 5 days • Days_7 (in/out) 7 days • Days_14 (in/out) 14 days • Days_30 (in/out) 30 days • Ineligible (in/out) No restriction period is being applied
CombinedPaymentPreferences .FlatShippingPreferences	FlatShippingPreferencesType	Conditionally	DO NOT USE THIS CONTAINER. As an alternative, use SetShippingDiscountProfiles to set all Flat Rate Shipping rules and preferences, and use GetShippingDiscountProfiles to retrieve the same information.
CombinedPaymentPreferences .FlatShippingPreferences .AmountPerAdditionalItem	AmountType (double)	Conditionally	DO NOT USE THIS FIELD. Flat Rate Shipping discount profiles are created and managed with SetShippingDiscountProfiles. Use GetShippingDiscountProfiles to retrieve Flat Rate Shipping discount profiles.
CombinedPaymentPreferences .FlatShippingPreferences .DeductionAmountPerAdditionalItem	AmountType (double)	Conditionally	DO NOT USE THIS FIELD. Flat Rate Shipping discount profiles are created and managed with SetShippingDiscountProfiles. Use GetShippingDiscountProfiles to retrieve Flat Rate Shipping discount profiles.
CombinedPaymentPreferences .FlatShippingPreferences .FlatRateInsuranceRangeCost	FlatRateInsuranceRangeCostType	Conditionally, repeatable: [0..6]	DO NOT USE THIS FIELD. Shipping insurance parameters are passed in through SetShippingDiscountProfiles and retrieved using GetShippingDiscountProfiles. FlatRateInsuranceRangeCost is only valid on the following eBay sites: AU, FR, IT, and IN.
CombinedPaymentPreferences .FlatShippingPreferences .FlatRateInsuranceRangeCost .FlatRateInsuranceRange	FlatRateInsuranceRangeCodeType	Conditionally	The price range for the shipment for which the insurance cost is being specified. This field is no longer applicable to SetUserPreferences or GetUserPreferences. Applicable values: • CustomCode (in/out) Reserved for internal or future use • FlatRateInsuranceRange1 (in/out) Range is 0.01 to 9.99 • FlatRateInsuranceRange2 (in/out) Range is 10.00 to 49.99 • FlatRateInsuranceRange3 (in/out) Range is 50.00 to 99.99 • FlatRateInsuranceRange4 (in/out) Range is 100.00 to 199.99 • FlatRateInsuranceRange5 (in/out) Range is 200.00 to 299.99 • FlatRateInsuranceRange6 (in/out) Range is 300.00 or greater
CombinedPaymentPreferences .FlatShippingPreferences .FlatRateInsuranceRangeCost .InsuranceCost	AmountType (double)	Conditionally	The cost of insurance for the specified price range. This field is no longer applicable to SetUserPreferences or GetUserPreferences.
CombinedPaymentPreferences .FlatShippingPreferences .FlatShippingRateOption	FlatShippingRateOptionCodeType	Conditionally	DO NOT USE THIS FIELD. Flat Rate Shipping discount profiles are created and managed with SetShippingDiscountProfiles. Use GetShippingDiscountProfiles to retrieve Flat Rate Shipping discount profiles. Applicable values: • ChargeAmountForEachAdditionalItem (in/out) Charge highest shipping cost for the first item and X amount for each additional item. • CustomCode (in/out) Reserved for internal or future use. • DeductAmountFromEachAdditionalItem (in/out) Charge highest shipping cost for the first item and deduct X amount from the shipping cost of each additional item. • ShipAdditionalItemsFree (in/out) Charge highest shipping cost for the first item and ship each additional item free.
CombinedPaymentPreferences .FlatShippingPreferences .InsuranceOption	InsuranceOptionCodeType	Conditionally	DO NOT USE THIS FIELD. Shipping insurance parameters are passed in through SetShippingDiscountProfiles and retrieved using GetShippingDiscountProfiles. InsuranceOption is only valid on the following eBay sites: AU, FR, IT, and IN. Applicable values: • CustomCode (in/out) Reserved for internal or future use • IncludedInShippingHandling (in/out) The seller is not charging separately for shipping insurance costs; any insurance is already included in the base shipping cost. • NotOffered (in/out) The seller does not offer shipping insurance to the buyer. • NotOfferedOnSite (out) Shipping insurance is not offered as a separate option on the site where the item is listed. (Some shipping services, such as DE_InsuredExpressOrCourier, include insurance as part of the service.) If another insurance option is specified in the listing request and the site does not support shipping insurance as a separate option, eBay will reset the insurance option to this value. At the time of this writing, this option is only meaningful for the eBay Germany, Austria, and Switzerland sites. • Optional (in/out) The seller offers the buyer the choice of paying for shipping insurance or not. • Required (in/out) The seller requires that the buyer pay for shipping insurance.
CrossPromotionPreferences	CrossPromotionPreferencesType	Conditionally	Container consisting of the seller's cross-promotion preferences. This container is returned when ShowCrossPromotionPreferences is included and set to true in the request. These preferences are only applicable for eBay Store owners.
CrossPromotionPreferences .CrossPromotionEnabled	boolean	Conditionally	(For eBay store owners only) Specifies whether cross-promotions are enabled for the seller's listings.
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. 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 or Store Inventory items) and in which sequence. Applicable values: • CustomCode (in/out) Reserved for internal or future use. • ShowAnyItems (in/out) Show any items, in no particular order. • ShowItemsWithBINFirst (in/out) Show items with a Buy It Now price first. • ShowOnlyItemsWithBIN (in/out) Show only items with a Buy It Now price. • ShowOnlyStoreItems (in/out) Show only store inventory items.
CrossPromotionPreferences .CrossSellItemSortFilter	ItemSortFilterCodeType	Conditionally	(For eBay store owners only) Specifies how to sort items displayed in a cross-sell promotion. 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. 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 or Store Inventory items) should be shown in upsell promotions and in which sequence. Applicable values: • CustomCode (in/out) Reserved for internal or future use. • ShowAnyItems (in/out) Show any items, in no particular order. • ShowItemsWithBINFirst (in/out) Show items with a Buy It Now price first. • ShowOnlyItemsWithBIN (in/out) Show only items with a Buy It Now price. • ShowOnlyStoreItems (in/out) Show only store inventory items.
CrossPromotionPreferences .UpSellItemSortFilter	ItemSortFilterCodeType	Conditionally	(For eBay store owners only) Specifies how to sort items used in an upsell promotion. 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.
EmailShipmentTrackingNumberPreference	boolean	Conditionally	Container consisting of the seller's preference for sending an email to the buyer with the shipping 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	Indicates whether or not the seller wishes to receive a copy of the customized email sent to the winning buyer.
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.
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.
ProStoresPreference .CheckoutRedirectProStores	boolean	Conditionally	Indicates whether third party checkout is to be redirected to the ProStores application specified via My eBay preferences.
ProStoresPreference .ProStoresDetails	ProStoresDetailsType	Conditionally	Details about the store.
ProStoresPreference .ProStoresDetails .SellerThirdPartyUsername	string	Conditionally	The username associated with the store. Returned only if the parent container is returned. Max length: 200.
ProStoresPreference .ProStoresDetails.Status	EnableCodeType	Conditionally	The status--whether enabled or disabled. Returned only if the parent container is returned. Applicable values: • CustomCode (in/out) Reserved for future use. • Disable (in/out) The entry is disabled. • Enable (in/out) The entry is enabled.
ProStoresPreference .ProStoresDetails.StoreName	string	Conditionally	The name of the store. Returned only if the parent container is returned. Max length: 200.
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 AddItem family of 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 (Chinese). • 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 Chinese auctions). Sellers must meet certain feedback requirements and/or be ID Verified to use this format. See Minimum Feedback Requirements for Various Features in the Trading Web Services guide. Fixed-price listings are listed on eBay.com, and they are listed in the seller's eBay Store if the seller is a Store owner. Stores fixed price items will be treated as basic fixed-price items. Permitted durations of 30 days and GTC are now available for store and non-store subscribers (in addition to the existing durations of 3, 5, 7, and 10 days). • LeadGeneration (in/out) Lead Generation format (advertisement-style listing to solicit inquiries or offers, no bidding or fixed price, listed on eBay). • StoresFixedPrice (in/out) This enumeration value should no longer be used in the Add/Revise/Relist family of calls. The FixedPriceItem listing type replaced the StoresFixedPrice listing type on all eBay sites on March 30, 2010. For GetItem and other 'Get' calls, this enumeration value may still be returned as the listing type if the listing was created before this value was deprecated. (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 .MinPrice	AmountType (double)	Conditionally	Specifies the lower limit of price range for the automatic search criteria.
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	Indicates whether the seller wants all transactions with eBay to use the address specified in SellerPaymentPreferences.SellerPaymentAddress.
SellerPaymentPreferences .DefaultPayPalEmailAddress	string	Conditionally	Specifies the default email address the seller uses for receiving PayPal payments.
SellerPaymentPreferences .DisplayPayNowButton	DisplayPayNowButtonCodeType	Conditionally	Determines whether the Pay Now button should always be displayed for the user's listings. 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 • 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 payments from buyers.
SellerPaymentPreferences .SellerPaymentAddress.Country	CountryCodeType	Conditionally	The country code of the user. If not provided as input for GetCart or SetCart, eBay uses the country associated with the SiteID in effect when the call is made. 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 for all policy-related information for a seller. Returned if ShowSellerProfilePreferences is included and set to true in the GetUserPreferences request. Note: Beginning with Version 763, the new Business Policies Management API and related Trading API containers/fields become available for testing in the Sandbox environment. In May 2012, Business Policies becomes fully functional and sellers can apply Business Policies profiles to live eBay listings.
SellerProfilePreferences .SellerProfileOptedIn	boolean	Conditionally	If included and set to true, this boolean flag indicates that a seller has opted in to Business Policies. If set to false, it means the seller has not opted into Business Policies. If the seller wants to use some features that are only provided by this service, they must opt in. Note: Beginning with Version 763, the new Business Policies Management API and related Trading API containers/fields become available for testing in the Sandbox environment. In May 2012, Business Policies becomes fully functional and sellers can apply Business Policies profiles to live eBay listings.
SellerProfilePreferences .SupportedSellerProfiles	SupportedSellerProfilesType	Conditionally	Container for all Business Policies profiles established for a seller's account. Returned only if SellerProfileOptedIn field is set to true. Note: Beginning with Version 763, the new Business Policies Management API and related Trading API containers/fields become available for testing in the Sandbox environment. In May 2012, Business Policies becomes fully functional and sellers can apply Business Policies profiles to live eBay listings.
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. Note: Beginning with Version 763, the new Business Policies Management API and related Trading API containers/fields become available for testing in the Sandbox environment. In May 2012, Business Policies becomes fully functional and sellers can apply Business Policies profiles to live eBay listings.
SellerProfilePreferences .SupportedSellerProfiles .SupportedSellerProfile .CategoryGroup	CategoryGroupType	Conditionally	Identifies the group of categories that a Business Policies profile is associated with. Current values are ALL (referring to a group of categories that are non-motor vehicles) or MOTOR_VEHICLE (referring to categories associated with motor vehicles only). Note: Beginning with Version 763, the new Business Policies Management API and related Trading API containers/fields become available for testing in the Sandbox environment. In May 2012, Business Policies becomes fully functional and sellers can apply Business Policies profiles to live eBay listings.
SellerProfilePreferences .SupportedSellerProfiles .SupportedSellerProfile .CategoryGroup.IsDefault	boolean	Conditionally	Identifies that the corresponding Business Policies profile is the default for the category group. Note: Beginning with Version 763, the new Business Policies Management API and related Trading API containers/fields become available for testing in the Sandbox environment. In May 2012, Business Policies becomes fully functional and sellers can apply Business Policies profiles to live eBay listings.
SellerProfilePreferences .SupportedSellerProfiles .SupportedSellerProfile .CategoryGroup.Name	string	Conditionally	Defines the name of the category group that a policy belongs to. Valid values are ALL (referring to all non-motor vehicle category groups)or MOTOR_VEHICLE (referring to only motor vehicle category groups). Note: Beginning with Version 763, the new Business Policies Management API and related Trading API containers/fields become available for testing in the Sandbox environment. In May 2012, Business Policies becomes fully functional and sellers can apply Business Policies profiles to live eBay listings.
SellerProfilePreferences .SupportedSellerProfiles .SupportedSellerProfile .ProfileID	long	Conditionally	Unique identifier of a Business Policies profile. Returned only if a seller has opted in to Business Policies (SellerProfileOptedIn=true). Note: Beginning with Version 763, the new Business Policies Management API and related Trading API containers/fields become available for testing in the Sandbox environment. In May 2012, Business Policies becomes fully functional and sellers can apply Business Policies profiles to live eBay listings.
SellerProfilePreferences .SupportedSellerProfiles .SupportedSellerProfile .ProfileName	string	Conditionally	The seller-defined name for a Business Policy profile. Returned if SellerProfileOptedIn is true, and the seller has provided a name for the profile. Note: Beginning with Version 763, the new Business Policies Management API and related Trading API containers/fields become available for testing in the Sandbox environment. In May 2012, Business Policies becomes fully functional and sellers can apply Business Policies profiles to live eBay listings.
SellerProfilePreferences .SupportedSellerProfiles .SupportedSellerProfile .ProfileType	string	Conditionally	Indicates the type of the Business Policies profile. Valid values are PAYMENT, RETURN_POLICY, and SHIPPING. Returned only if a seller has opted in to Business Policies (SellerProfileOptedIn=true). Note: Beginning with Version 763, the new Business Policies Management API and related Trading API containers/fields become available for testing in the Sandbox environment. In May 2012, Business Policies becomes fully functional and sellers can apply Business Policies profiles to live eBay listings.
SellerProfilePreferences .SupportedSellerProfiles .SupportedSellerProfile .ShortSummary	string	Conditionally	Seller-provided description of a business policy. Returned if SellerProfileOptedIn is true, and the seller has provided a description for the profile. Note: Beginning with Version 763, the new Business Policies Management API and related Trading API containers/fields become available for testing in the Sandbox environment. In May 2012, Business Policies becomes fully functional and sellers can apply Business Policies profiles to live eBay listings.
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: 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. 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.

GetUserPreferences Detail Controls

Detail Control: DetailLevel

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

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 is 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. Also available is the .txt version of this XML.

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

GetUserPreferences Change History

Version	Description
763 2012-02-28	GetUserPreferencesRequest.ShowSellerProfilePreferences (new): Boolean flag to indicate if the information for a seller's policies will be returned. If set to true, all information for all policieis for seller is returned. This feature is currently only available for testing in a Sandbox environment and will not be available in Production until May 2012. GetUserPreferencesResponse.SellerProfilePreferences (new): Parent container for all information related to a seller's policies. This feature is currently only available for testing in a Sandbox environment and will not be available in Production until May 2012. GetUserPreferencesResponse.SellerProfilePreferences.SellerProfileOptedIn (new): Boolean flag that indicates whether a seller has opted in to the Business Policies Management Service. If set to true, this means a seller has opted in. This feature is currently only available for testing in a Sandbox environment and will not be available in Production until May 2012. GetUserPreferencesResponse.SellerProfilePreferences.SupportedSellerProfiles (new): Top-level container for all policies that a seller has defined. This feature is currently only available for testing in a Sandbox environment and will not be available in Production until May 2012. GetUserPreferencesResponse.SellerProfilePreferences.SupportedSellerProfiles.SupportedSellerProfile (new): Container for a specific payment, returns, or shipping policy. This feature is currently only available for testing in a Sandbox environment and will not be available in Production until May 2012. GetUserPreferencesResponse.SellerProfilePreferences.SupportedSellerProfiles.SupportedSellerProfile.ProfileID (new): Unique identifier for policy. eBay returns a ProfileID after the seller completes an AddItem call. This feature is currently only available for testing in a Sandbox environment and will not be available in Production until May 2012. GetUserPreferencesResponse.SellerProfilePreferences.SupportedSellerProfiles.SupportedSellerProfile.ProfileType (new): The type of business policy. Valid values are PAYMENT, RETURN_POLICY, and SHIPPING. This feature is currently only available for testing in a Sandbox environment and will not be available in Production until May 2012. GetUserPreferencesResponse.SellerProfilePreferences.SupportedSellerProfiles.SupportedSellerProfile.ProfileName (new): Unique name for a policy that the seller defines. This feature is currently only available for testing in a Sandbox environment and will not be available in Production until May 2012. GetUserPreferencesResponse.SupportedSellerProfiles.ShortSummary (new): Brief description of a policy that the seller provides. This feature is currently only available for testing in a Sandbox environment and will not be available in Production until May 2012. GetUserPreferencesResponse.SupportedSellerProfiles.CategoryGroup (new): The group of categories that a policy applies to. This feature is currently only available for testing in a Sandbox environment and will not be available in Production until May 2012. GetUserPreferencesResponse.SupportedSellerProfiles.CategoryGroup.Name (new): The name of the category group. This feature is currently only available for testing in a Sandbox environment and will not be available in Production until May 2012. GetUserPreferences.SupportedSellerProfiles.CategoryGroup.IsDefault (new): Boolean flag that indicates whether a policy is the default policy for a specific category group. There can be only one default policy for a category group per site. This feature is currently only available for testing in a Sandbox environment and will not be available in Production until May 2012.
745 2011-10-26	UnpaidItemAssistancePreferences.AutoOptDonationRefund (new): 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 (new): Flag used to return the RequiredShipPhoneNumberPreference in the response. GetUserPreferencesResponseType.RequiredShipPhoneNumberPreference (new): 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.

User-Contributed Notes

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

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. 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.
ShowCrossPromotionPreferences	boolean	Optional	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.
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.
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 included and set to true, the seller's Business Policies profile information is returned in the response. Note: Beginning with Version 763, the new Business Policies Management API and related Trading API containers/fields become available for testing in the Sandbox environment. In May 2012, Business Policies becomes fully functional and sellers can apply Business Policies profiles to live eBay listings. 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.

Trading API Call Reference Version 773