Overview 
Namespace 
WSDL 
Schema 
 Component 
Index 
PREV C-TYPE   NEXT C-TYPE
FRAMES   NO FRAMES NS-Bindings
SUMMARY: XML REP | DERIVED | USE
DETAIL: DESC | XML SRC | TYPE | ATTR | CHILD
eBay Trading API
complexType "ns:GetUserPreferencesResponseType"
Namespace:
urn:ebay:apis:eBLBaseComponents
Content:
complex, 37 elements, elem. wildcard
Defined:
globally in Schema in ebaySvc.wsdl; see XML source
Includes:
definitions of 22 elements
Used:
at 1 location
Component Diagram
XML Representation Summary
<...>
   
Content: 
ns:Timestamp?, ns:Ack?, ns:CorrelationID?, ns:Errors*, ns:Message?, ns:Version?, ns:Build?, ns:NotificationEventName?, ns:DuplicateInvocationDetails?, ns:RecipientUserID?, ns:EIASToken?, ns:NotificationSignature?, ns:HardExpirationWarning?, ns:BotBlock?, ns:ExternalUserData?, {any}*, ns:BidderNoticePreferences?, ns:CombinedPaymentPreferences?, ns:CrossPromotionPreferences?, ns:SellerPaymentPreferences?, ns:SellerFavoriteItemPreferences?, ns:EndOfAuctionEmailPreferences?, ns:EmailShipmentTrackingNumberPreference?, ns:RequiredShipPhoneNumberPreference?, ns:ProStoresPreference?, ns:UnpaidItemAssistancePreferences?, ns:SellerExcludeShipToLocationPreferences?, ns:PurchaseReminderEmailPreferences?, ns:SellerThirdPartyCheckoutDisabled?, ns:SellerProfilePreferences?, ns:SellerReturnPreferences?, ns:OfferGlobalShippingProgramPreference?, ns:DispatchCutoffTimePreference?, ns:GlobalShippingProgramListingPreference?, ns:OverrideGSPServiceWithIntlServicePreference?, ns:PickupDropoffSellerPreference?, ns:OutOfStockControlPreference?, ns:eBayPLUSPreference*
</...>
All Direct / Indirect Based Elements (1):
ns:GetUserPreferencesResponse
Known Usage Locations
Annotation
Contains some or all of the authenticated user's preferences. The preferences are grouped in sets and are returned according to the flag settings in the request.
Type Definition Detail
Type Derivation Tree
ns:AbstractResponseType (extension)
  ns:GetUserPreferencesResponseType
XML Source (w/o annotations (23); see within schema source)
<xs:complexType name="GetUserPreferencesResponseType">
<xs:complexContent>
<xs:extension base="ns:AbstractResponseType">
<xs:sequence>
<xs:element minOccurs="0" name="BidderNoticePreferences" type="ns:BidderNoticePreferencesType"/>
<xs:element minOccurs="0" name="CombinedPaymentPreferences" type="ns:CombinedPaymentPreferencesType"/>
<xs:element minOccurs="0" name="CrossPromotionPreferences" type="ns:CrossPromotionPreferencesType"/>
<xs:element minOccurs="0" name="SellerPaymentPreferences" type="ns:SellerPaymentPreferencesType"/>
<xs:element minOccurs="0" name="EndOfAuctionEmailPreferences" type="ns:EndOfAuctionEmailPreferencesType"/>
<xs:element minOccurs="0" name="EmailShipmentTrackingNumberPreference" type="xs:boolean"/>
<xs:element minOccurs="0" name="RequiredShipPhoneNumberPreference" type="xs:boolean"/>
<xs:element minOccurs="0" name="ProStoresPreference" type="ns:ProStoresCheckoutPreferenceType"/>
<xs:element minOccurs="0" name="SellerThirdPartyCheckoutDisabled" type="xs:boolean"/>
<xs:element minOccurs="0" name="SellerProfilePreferences" type="ns:SellerProfilePreferencesType"/>
<xs:element minOccurs="0" name="SellerReturnPreferences" type="ns:SellerReturnPreferencesType"/>
<xs:element minOccurs="0" name="OfferGlobalShippingProgramPreference" type="xs:boolean"/>
<xs:element minOccurs="0" name="DispatchCutoffTimePreference" type="ns:DispatchCutoffTimePreferencesType"/>
<xs:element minOccurs="0" name="GlobalShippingProgramListingPreference" type="xs:boolean"/>
<xs:element minOccurs="0" name="OverrideGSPServiceWithIntlServicePreference" type="xs:boolean"/>
<xs:element minOccurs="0" name="PickupDropoffSellerPreference" type="xs:boolean"/>
<xs:element minOccurs="0" name="OutOfStockControlPreference" type="xs:boolean"/>
<xs:element maxOccurs="unbounded" minOccurs="0" name="eBayPLUSPreference" type="ns:eBayPLUSPreferenceType"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
Content Element Detail (all declarations defined in this component; 22/38)
ns:BidderNoticePreferences
Type:
ns:BidderNoticePreferencesType, complex content
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.
Component Diagram
XML Representation Summary
<ns:BidderNoticePreferences>
   
Content: 
ns:UnsuccessfulBidderNoticeIncludeMyItems?, {any}*
</ns:BidderNoticePreferences>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="BidderNoticePreferences" type="ns:BidderNoticePreferencesType"/>
ns:CombinedPaymentPreferences
Type:
ns:CombinedPaymentPreferencesType, complex content
Container consisting of the seller's Combined Invoice preferences. These preferences are used to allow Combined Invoice orders. This container is returned when ShowCombinedPaymentPreferences is included and set to true in the request.
Component Diagram
XML Representation Summary
<ns:CombinedPaymentPreferences>
   
Content: 
ns:CalculatedShippingPreferences?, ns:CombinedPaymentOption?, ns:CombinedPaymentPeriod?, ns:FlatShippingPreferences?, {any}*
</ns:CombinedPaymentPreferences>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="CombinedPaymentPreferences" type="ns:CombinedPaymentPreferencesType"/>
ns:CrossPromotionPreferences
Type:
ns:CrossPromotionPreferencesType, complex content
This container is deprecated.
Component Diagram
XML Representation Summary
<ns:CrossPromotionPreferences>
   
Content: 
ns:CrossPromotionEnabled?, ns:CrossSellItemFormatSortFilter?, ns:CrossSellGallerySortFilter?, ns:CrossSellItemSortFilter?, ns:UpSellItemFormatSortFilter?, ns:UpSellGallerySortFilter?, ns:UpSellItemSortFilter?, {any}*
</ns:CrossPromotionPreferences>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="CrossPromotionPreferences" type="ns:CrossPromotionPreferencesType"/>
ns:DispatchCutoffTimePreference
Type:
ns:DispatchCutoffTimePreferencesType, complex content
Contains information about a seller's order cutoff time preferences for same-day shipping. If the seller specifies a value of '0' in Item.DispatchTimeMax to offer same-day handling when listing an item, the seller's shipping time commitment depends on the order cutoff time set for the listing site, as indicated by DispatchCutoffTimePreference.CutoffTime. Returned when ShowDispatchCutoffTimePreferences is included and set to true.

Note: For sellers opted in to the feature that supports different order cutoff times for each business day, the order cutoff time returned in this container may not be accurate. In order for the seller to confirm the actual order cutoff time for same-day handling, that seller should view Shipping Preferences in My eBay.
Component Diagram
XML Representation Summary
<ns:DispatchCutoffTimePreference>
   
Content: 
ns:CutoffTime?, {any}*
</ns:DispatchCutoffTimePreference>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="DispatchCutoffTimePreference" type="ns:DispatchCutoffTimePreferencesType"/>
ns:eBayPLUSPreference
Type:
ns:eBayPLUSPreferenceType, complex content
Contains information about each country where the seller is eligible to offer eBay Plus on listings (one eBayPLUSPreference container per country), as well as the seller's opt-in status and listing preference for each country.

eBay Plus is a premium account option for buyers, which provides benefits such as fast free domestic shipping and free returns on selected items. Top Rated eBay sellers must opt in to eBay Plus to offer the program on a per-listing basis.

Note: Currently, eBay Plus is available only to buyers in Germany and Australia. In Australia, the seller has no control/responsibility over setting the eBay Plus feature for a listing. Instead, eBay will evaluate/determine whether a listing is eligible for eBay Plus.
Component Diagram
XML Representation Summary
<ns:eBayPLUSPreference>
   
Content: 
ns:Country?, ns:OptInStatus?, ns:ListingPreference?, {any}*
</ns:eBayPLUSPreference>
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" name="eBayPLUSPreference" type="ns:eBayPLUSPreferenceType"/>
ns:EmailShipmentTrackingNumberPreference
Type:
xs:boolean, predefined, simple content
Container consisting of the seller's preference for sending an email to the buyer with the shipment tracking number. This container is returned when ShowEmailShipmentTrackingNumberPreference is included and set to true in the request.
XML Representation Summary
<ns:EmailShipmentTrackingNumberPreference>
   
Content: 
{ xs:boolean }
</ns:EmailShipmentTrackingNumberPreference>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="EmailShipmentTrackingNumberPreference" type="xs:boolean"/>
ns:EndOfAuctionEmailPreferences
Type:
ns:EndOfAuctionEmailPreferencesType, complex content
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.
Component Diagram
XML Representation Summary
<ns:EndOfAuctionEmailPreferences>
   
Content: 
ns:TemplateText?, ns:LogoURL?, ns:LogoType?, ns:EmailCustomized?, ns:TextCustomized?, ns:LogoCustomized?, ns:CopyEmail?, {any}*
</ns:EndOfAuctionEmailPreferences>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="EndOfAuctionEmailPreferences" type="ns:EndOfAuctionEmailPreferencesType"/>
ns:GlobalShippingProgramListingPreference
Type:
xs:boolean, predefined, simple content
If the ShowGlobalShippingProgramListingPreference field is submitted and set to true, this flag is returned. A returned value of true indicates that the seller's new listings will enable the Global Shipping Program by default.
XML Representation Summary
<ns:GlobalShippingProgramListingPreference>
   
Content: 
{ xs:boolean }
</ns:GlobalShippingProgramListingPreference>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="GlobalShippingProgramListingPreference" type="xs:boolean"/>
ns:OfferGlobalShippingProgramPreference
Type:
xs:boolean, predefined, simple content
This flag indicates whether the seller has opted in to the Global Shipping Program and is able to offer global shipping to international buyers. Returned when ShowGlobalShippingProgramPreference is included and set to true.
XML Representation Summary
<ns:OfferGlobalShippingProgramPreference>
   
Content: 
{ xs:boolean }
</ns:OfferGlobalShippingProgramPreference>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="OfferGlobalShippingProgramPreference" type="xs:boolean"/>
ns:OutOfStockControlPreference
Type:
xs:boolean, predefined, simple content
This boolean field is returned if the ShowOutOfStockControlPreference field is included and set to true in the request. This field will be returned as true if the seller has set SetUserPreferences.OutOfStockControlPreference to true.
XML Representation Summary
<ns:OutOfStockControlPreference>
   
Content: 
{ xs:boolean }
</ns:OutOfStockControlPreference>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="OutOfStockControlPreference" type="xs:boolean"/>
ns:OverrideGSPServiceWithIntlServicePreference
Type:
xs:boolean, predefined, simple content
If the ShowOverrideGSPServiceWithIntlServicePreference field is submitted and set to true, this flag is returned. A returned value of true indicates that for the seller's listings that specify an international shipping service for any Global Shipping-eligible country, the specified service will take precedence and be the listing's default international shipping option for buyers in that country, rather than the Global Shipping Program.

A returned value of false indicates that the Global Shipping program will take precedence over any international shipping service as the default option in Global Shipping-eligible listings for shipping to any Global Shipping-eligible country.
XML Representation Summary
<ns:OverrideGSPServiceWithIntlServicePreference>
   
Content: 
{ xs:boolean }
</ns:OverrideGSPServiceWithIntlServicePreference>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="OverrideGSPServiceWithIntlServicePreference" type="xs:boolean"/>
ns:PickupDropoffSellerPreference
Type:
xs:boolean, predefined, simple content
This boolean field is returned if the ShowPickupDropoffPreferences field is included and set to true in the request. This field will be returned as true if the seller has enabled the Click and Collect feature at the account level. All of the seller's new listings will by default be eligible to be evaluated for the Click and Collect feature. With the Click and Collect feature, a buyer can purchase certain items on eBay and collect them at a local store. Buyers are notified by eBay once their items are available. The Click and Collect feature is only available to large merchants on the eBay UK (site ID 3), eBay Australia (Site ID 15), and eBay Germany (Site ID 77) sites.

Note: The Click and Collect program no longer allows sellers to set the Click and Collect preference at the listing level.
XML Representation Summary
<ns:PickupDropoffSellerPreference>
   
Content: 
{ xs:boolean }
</ns:PickupDropoffSellerPreference>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="PickupDropoffSellerPreference" type="xs:boolean"/>
ns:ProStoresPreference
Type:
ns:ProStoresCheckoutPreferenceType, complex content
This field is deprecated.
Component Diagram
XML Representation Summary
<ns:ProStoresPreference>
   
Content: 
ns:CheckoutRedirectProStores?, ns:ProStoresDetails[0..0], {any}*
</ns:ProStoresPreference>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="ProStoresPreference" type="ns:ProStoresCheckoutPreferenceType"/>
ns:PurchaseReminderEmailPreferences
Type:
ns:PurchaseReminderEmailPreferencesType, complex content
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.
Component Diagram
XML Representation Summary
<ns:PurchaseReminderEmailPreferences>
   
Content: 
ns:PurchaseReminderEmailPreferences?, {any}*
</ns:PurchaseReminderEmailPreferences>
XML Source (w/o annotations (1); see within schema source)
ns:RequiredShipPhoneNumberPreference
Type:
xs:boolean, predefined, simple content
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.
XML Representation Summary
<ns:RequiredShipPhoneNumberPreference>
   
Content: 
{ xs:boolean }
</ns:RequiredShipPhoneNumberPreference>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="RequiredShipPhoneNumberPreference" type="xs:boolean"/>
ns:SellerExcludeShipToLocationPreferences
Type:
ns:SellerExcludeShipToLocationPreferencesType, complex content
Container consisting of a list of the seller's excluded shipping locations. The returned list mirrors the seller's current Exclude shipping locations list in My eBay's shipping preferences. An excluded shipping location in My eBay can be an entire geographical region (such as Middle East) or only an individual country (such as Iraq).

Sellers can override these default settings for an individual listing by using the Item.ShippingDetails.ExcludeShipToLocation field in the Add/Revise/Relist calls. This container is returned if the ShowSellerExcludeShipToLocationPreference field is included and set to true in the request.
Component Diagram
XML Representation Summary
<ns:SellerExcludeShipToLocationPreferences>
   
Content: 
ns:ExcludeShipToLocation*, {any}*
</ns:SellerExcludeShipToLocationPreferences>
XML Source (w/o annotations (1); see within schema source)
ns:SellerFavoriteItemPreferences
Type:
ns:SellerFavoriteItemPreferencesType, complex content
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.
Component Diagram
XML Representation Summary
<ns:SellerFavoriteItemPreferences>
   
Content: 
ns:SearchKeywords?, ns:StoreCategoryID?, ns:ListingType?, ns:SearchSortOrder?, ns:MinPrice?, ns:MaxPrice?, ns:FavoriteItemID*, {any}*
</ns:SellerFavoriteItemPreferences>
XML Source (w/o annotations (1); see within schema source)
ns:SellerPaymentPreferences
Type:
ns:SellerPaymentPreferencesType, complex content
Container consisting of the seller's payment preferences. This container is returned when ShowSellerPaymentPreferences is included and set to true in the request.
Component Diagram
XML Representation Summary
<ns:SellerPaymentPreferences>
   
Content: 
ns:AlwaysUseThisPaymentAddress?, ns:DisplayPayNowButton?, ns:PayPalPreferred?, ns:DefaultPayPalEmailAddress?, ns:PayPalAlwaysOn?, ns:SellerPaymentAddress?, ns:UPSRateOption?, ns:FedExRateOption?, ns:USPSRateOption?, {any}*
</ns:SellerPaymentPreferences>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="SellerPaymentPreferences" type="ns:SellerPaymentPreferencesType"/>
ns:SellerProfilePreferences
Type:
ns:SellerProfilePreferencesType, complex content
Parent response container consisting of high-level information for all Business Policies defined for the user's account. This container is returned if ShowSellerProfilePreferences is included and set to true in the GetUserPreferences request (and one or more Business Policies are defined for the user's account).
Component Diagram
XML Representation Summary
<ns:SellerProfilePreferences>
   
Content: 
ns:SellerProfileOptedIn?, ns:SupportedSellerProfiles?
</ns:SellerProfilePreferences>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="SellerProfilePreferences" type="ns:SellerProfilePreferencesType"/>
ns:SellerReturnPreferences
Type:
ns:SellerReturnPreferencesType, complex content
Container consisting of the OptedIn flag that indicates whether or not the seller has opted in to eBay Managed Returns. This container is only returned if ShowSellerReturnPreferences is included and set to true in the request.
Component Diagram
XML Representation Summary
<ns:SellerReturnPreferences>
   
Content: 
ns:OptedIn?, {any}*
</ns:SellerReturnPreferences>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="SellerReturnPreferences" type="ns:SellerReturnPreferencesType"/>
ns:SellerThirdPartyCheckoutDisabled
Type:
xs:boolean, predefined, simple content
This field is deprecated along with third-party checkout.
XML Representation Summary
<ns:SellerThirdPartyCheckoutDisabled>
   
Content: 
{ xs:boolean }
</ns:SellerThirdPartyCheckoutDisabled>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="SellerThirdPartyCheckoutDisabled" type="xs:boolean"/>
ns:UnpaidItemAssistancePreferences
Type:
ns:UnpaidItemAssistancePreferencesType, complex content
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.
Component Diagram
XML Representation Summary
<ns:UnpaidItemAssistancePreferences>
   
Content: 
ns:DelayBeforeOpeningDispute?, ns:OptInStatus?, ns:AutoRelist?, ns:RemoveAllExcludedUsers?, ns:ExcludedUser*, ns:AutoOptDonationRefund?, {any}*
</ns:UnpaidItemAssistancePreferences>
XML Source (w/o annotations (1); see within schema source)
Overview 
Namespace 
WSDL 
Schema 
 Component 
Index 
PREV C-TYPE   NEXT C-TYPE
FRAMES   NO FRAMES NS-Bindings
SUMMARY: XML REP | DERIVED | USE
DETAIL: DESC | XML SRC | TYPE | ATTR | CHILD
eBay Trading API
WSDL documentation generated with FlexDoc/XML 1.13 using FlexDoc/XML WSDLDoc 1.2.5 template set. All XSD diagrams generated by FlexDoc/XML DiagramKit.