GetUserPreferences - Call Reference - eBay Trading Web Services

GetUserPreferences

Retrieves some or all of a user's preferences. The set of preferences retrieved depends on the set of flags specified in the request.

See Managing User Preferences.

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

Argument	Type	Reqd?	Meaning
Standard Input Fields [Jump to call-specific fields]
ErrorLanguage	string	Optional	Use ErrorLanguage to return error strings for the call in a different language from the language commonly associated with the site that the requesting user is registered with. Specify the standard RFC 3066 language identification tag (e.g., en_US). ID--- country ----- ----- de_AT Austria de_CH Switzerland de_DE Germany en_AU Australia en_CA Canada en_GB United Kingdom en_SG Singapore en_US United States es_ES Spain fr_BE Belgium (French) fr_CA Canada (French) fr_FR France it_IT Italy nl_BE Belgium (Dutch) nl_NL Netherlands zh_CN China en_IN India en_IE Ireland zh_HK Hong Kong See Tags for the Identification of Languages.
MessageID	string	Optional	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.
Call-specific Input Fields
ShowBidderNoticePreferences	boolean	Optional	If true, requests a seller's preferences for receiving bidder notices.
ShowCombinedPaymentPreferences	boolean	Optional	DO NOT USE THIS FIELD. Use 'GetShippingDiscountProfiles' to access similar information. If true, requests a seller's preferences for accepting payments that combine item purchases into one order.
ShowCrossPromotionPreferences	boolean	Optional	If true, requests a seller's cross-promotion preferences, such as whether cross-promotions are enabled and the sort filters used.
ShowEmailShipmentTrackingNumberPreference	boolean	Optional	If true, returns the preference related to emailing the email shipment tracking number. Default: false.
ShowEndOfAuctionEmailPreferences	boolean	Optional	If true, displays the seller's end of auction email preferences.
ShowProStoresPreferences	boolean	Optional	If true, returns ProStores checkout preferences. Default: false.
ShowSellerFavoriteItemPreferences	boolean	Optional	If true, retrieves preferences the seller has set for displaying items on a buyer's favorite sellers page and in the favorite sellers email digest.
ShowSellerPaymentPreferences	boolean	Optional	If true, displays a seller's payment preferences, for displaying a Pay Now button, accepting PayPal, and so on.

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 may be missing some XML fields and attributes. This is a documentation limitation only (see Limitations of This Document).

<?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>
      <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>
  <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>
    <PayPalAlwaysOn> boolean </PayPalAlwaysOn>
    <PayPalPreferred> boolean </PayPalPreferred>
    <SellerPaymentAddress> AddressType 
      <Country> CountryCodeType </Country>
    </SellerPaymentAddress>
    <UPSRateOption> UPSRateOptionCodeType </UPSRateOption>
  </SellerPaymentPreferences>
</GetUserPreferencesResponse>

Return Value	Type	Returned?	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 (repeatable)	Conditionally	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.
Errors.ErrorParameters	ErrorParameterType (repeatable)	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 [ 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	Contains a seller's preferences for receiving bidder notices. Returned when the request sets ShowBidderNoticePreferences to true.
BidderNoticePreferences .UnsuccessfulBidderNoticeIncludeMyItems	boolean	Conditionally	If true, sends the seller a notice containing the contact information for unsuccessful bidders.
CombinedPaymentPreferences	CombinedPaymentPreferencesType	Conditionally	DO NOT USE THIS FIELD. Use 'GetShippingDiscountProfiles' to retrieve similar information. Contains a seller's preferences for accepting combined payments. Returned when ShowCombinedPaymentPreferences is true.
CombinedPaymentPreferences .CalculatedShippingPreferences	CalculatedShippingPreferencesType	Conditionally	Contains a seller's preferences for having shipping costs calculated by eBay.
CombinedPaymentPreferences .CalculatedShippingPreferences .CalculatedShippingAmountForEntireOrder	AmountType (double)	Conditionally	The calculated shipping amount for the entire order.
CombinedPaymentPreferences .CalculatedShippingPreferences .CalculatedShippingChargeOption	CalculatedShippingChargeOptionCodeType	Conditionally	Specifies whether to charge the actual shipping and handling cost for the entire order or for each item. 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	Specifies whether to calculate the actual rate shipping based on the combined item weight or the individual item weight. 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	Whether the seller offers shipping insurance and, if so, whether the insurance is optional or required. Flat and calculated shipping. 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 purchases in order to receive a discount. Applicable values: • CustomCode (in/out) Reserved for internal or future use • DiscountSpecified (in/out) Yes Specify Discount Now • NoCombinedPayment (in/out) No Combined Purchase • SpecifyDiscountLater (in/out) Yes Specify Discount Later
CombinedPaymentPreferences .CombinedPaymentPeriod	CombinedPaymentPeriodCodeType	Conditionally	Specifies the period in which the user will allow buyers to combine purchases in order to receive a discount. 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	Specifies a seller's preferences for flat-rate shipping.
CombinedPaymentPreferences .FlatShippingPreferences .AmountPerAdditionalItem	AmountType (double)	Conditionally	If the user specifies ChargeAmountForEachAdditionalItem for FlatShippingRateOption, then this value is used to specify how much to charge for each additional item.
CombinedPaymentPreferences .FlatShippingPreferences .DeductionAmountPerAdditionalItem	AmountType (double)	Conditionally	If the user specifies DeductAmountFromEachAdditionalItem for FlatShippingRateOption, then this value is used to specify how much to deduct for each additional item shipped.
CombinedPaymentPreferences .FlatShippingPreferences .FlatRateInsuranceRangeCost	FlatRateInsuranceRangeCostType	Conditionally	For the given range, specifies the cost of insurance. If the InsuranceOption is either Optional or Required, then 6 instances of this field must be specified, one for each cost range.
CombinedPaymentPreferences .FlatShippingPreferences .FlatRateInsuranceRangeCost .FlatRateInsuranceRange	FlatRateInsuranceRangeCodeType	Conditionally	The price range for the shipment for which the insurance cost is being specified. 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.
CombinedPaymentPreferences .FlatShippingPreferences .FlatShippingRateOption	FlatShippingRateOptionCodeType	Conditionally	Specifies how the user wants flat-rate shipping to be calculated. 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	Whether the seller offers shipping insurance and, if so, whether the insurance is optional or required. Flat and calculated shipping. 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	Contains a seller's cross-promotion preferences. Returned when ShowCrossPromotionPreferences is true.
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	Contains the user's preference for the email shipment tracking number.
EndOfAuctionEmailPreferences	EndOfAuctionEmailPreferencesType	Conditionally	Contains the user's end of auction email preferences.
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 end of auction (for auctions) or end of transaction (for Buy It Now) emails.
EndOfAuctionEmailPreferences .TextCustomized	boolean	Conditionally	Indicates whether or not the text of the customized message will be customized.
ProStoresPreference	ProStoresCheckoutPreferenceType	Conditionally	Details about ProStores and checkout preferences. Returned only if requested on input.
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.
SellerFavoriteItemPreferences	SellerFavoriteItemPreferencesType	Conditionally	Contains a seller's preferences for displaying items on a buyer's Favorite Sellers' Items page or Favorite Sellers' Items digest.
SellerFavoriteItemPreferences .FavoriteItemID	ItemIDType (string) (repeatable)	Conditionally	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 the following auction types: Chinese, Dutch, and Live. • 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. Starting in early June 2008, on the Italy site, stores fixed price items will be treated as basic fixed-price items. On the Italy site, 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) A fixed-price format for eBay Store sellers. Store Inventory listings appear after other listings in regular browse and search item lists on eBay. They have a lower Insertion Fee and longer listing durations. Only available to sellers who have an eBay Store. Store Inventory listings are listed on eBay.com, and they are also listed in the seller's eBay Store. Starting in early June 2008, on the Italy site, stores fixed price items will be treated as basic fixed-price items; please see the documentation for FixedPriceItem (that is, for the basic fixed-price item format). (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. • LowestPriced (in/out) Lists items by price in ascending order. The item with the lowest starting price 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	Contains a seller's preferences for accepting payments. Returned when ShowSellerPaymentPreferences is true.
SellerPaymentPreferences .AlwaysUseThisPaymentAddress	boolean	Conditionally	Indicates whether the seller wants all transactions with eBay to use the address specified in 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 .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 Postal 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

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

An inline sample will be added in a future release. Please refer to the Samples section of the eBay Web Services Guide chapter for GetUserPreferences.

GetUserPreferences Change History

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

This document was generated with a customized version of the apireferencedocs tool [0.5M zip].

eBay Trading API Call Reference Version 579

eBay Trading API
Call Reference Version 579