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:GetUserPreferencesRequestType"
Namespace:
urn:ebay:apis:eBLBaseComponents
Content:
complex, 32 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:DetailLevel*, ns:ErrorLanguage?, ns:MessageID?, ns:Version?, ns:EndUserIP?, ns:ErrorHandling?, ns:InvocationID?, ns:OutputSelector*, ns:WarningLevel?, ns:BotBlock?, {any}*, ns:ShowBidderNoticePreferences, ns:ShowCombinedPaymentPreferences, ns:ShowCrossPromotionPreferences, ns:ShowSellerPaymentPreferences, ns:ShowEndOfAuctionEmailPreferences?, ns:ShowSellerFavoriteItemPreferences?, ns:ShowProStoresPreferences?, ns:ShowEmailShipmentTrackingNumberPreference?, ns:ShowRequiredShipPhoneNumberPreference?, ns:ShowSellerExcludeShipToLocationPreference?, ns:ShowUnpaidItemAssistancePreference?, ns:ShowPurchaseReminderEmailPreferences?, ns:ShowUnpaidItemAssistanceExclusionList?, ns:ShowSellerProfilePreferences, ns:ShowSellerReturnPreferences?, ns:ShowGlobalShippingProgramPreference?, ns:ShowDispatchCutoffTimePreferences?, ns:ShowGlobalShippingProgramListingPreference?, ns:ShowOverrideGSPServiceWithIntlServicePreference?, ns:ShowPickupDropoffPreferences?, ns:ShowOutOfStockControlPreference?, ns:ShoweBayPLUSPreference?
</...>
All Direct / Indirect Based Elements (1):
ns:GetUserPreferencesRequest
Known Usage Locations
Annotation
Retrieves the specified user preferences for the authenticated caller.
Type Definition Detail
Type Derivation Tree
ns:AbstractRequestType (extension)
  ns:GetUserPreferencesRequestType
XML Source (w/o annotations (23); see within schema source)
<xs:complexType name="GetUserPreferencesRequestType">
<xs:complexContent>
<xs:extension base="ns:AbstractRequestType">
<xs:sequence>
<xs:element name="ShowBidderNoticePreferences" type="xs:boolean"/>
<xs:element name="ShowCombinedPaymentPreferences" type="xs:boolean"/>
<xs:element name="ShowCrossPromotionPreferences" type="xs:boolean"/>
<xs:element name="ShowSellerPaymentPreferences" type="xs:boolean"/>
<xs:element minOccurs="0" name="ShowEndOfAuctionEmailPreferences" type="xs:boolean"/>
<xs:element minOccurs="0" name="ShowSellerFavoriteItemPreferences" type="xs:boolean"/>
<xs:element minOccurs="0" name="ShowProStoresPreferences" type="xs:boolean"/>
<xs:element minOccurs="0" name="ShowEmailShipmentTrackingNumberPreference" type="xs:boolean"/>
<xs:element minOccurs="0" name="ShowRequiredShipPhoneNumberPreference" type="xs:boolean"/>
<xs:element minOccurs="0" name="ShowSellerExcludeShipToLocationPreference" type="xs:boolean"/>
<xs:element minOccurs="0" name="ShowUnpaidItemAssistancePreference" type="xs:boolean"/>
<xs:element minOccurs="0" name="ShowPurchaseReminderEmailPreferences" type="xs:boolean"/>
<xs:element minOccurs="0" name="ShowUnpaidItemAssistanceExclusionList" type="xs:boolean"/>
<xs:element name="ShowSellerProfilePreferences" type="xs:boolean"/>
<xs:element minOccurs="0" name="ShowSellerReturnPreferences" type="xs:boolean"/>
<xs:element minOccurs="0" name="ShowGlobalShippingProgramPreference" type="xs:boolean"/>
<xs:element minOccurs="0" name="ShowDispatchCutoffTimePreferences" type="xs:boolean"/>
<xs:element minOccurs="0" name="ShowGlobalShippingProgramListingPreference" type="xs:boolean"/>
<xs:element minOccurs="0" name="ShowOverrideGSPServiceWithIntlServicePreference" type="xs:boolean"/>
<xs:element minOccurs="0" name="ShowPickupDropoffPreferences" type="xs:boolean"/>
<xs:element minOccurs="0" name="ShowOutOfStockControlPreference" type="xs:boolean"/>
<xs:element minOccurs="0" name="ShoweBayPLUSPreference" type="xs:boolean"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
Content Element Detail (all declarations defined in this component; 22/33)
ns:ShowBidderNoticePreferences
Type:
xs:boolean, predefined, simple content
If included and set to true, the seller's preference for receiving contact information for unsuccessful bidders is returned in the response.
XML Representation Summary
<ns:ShowBidderNoticePreferences>
   
Content: 
{ xs:boolean }
</ns:ShowBidderNoticePreferences>
XML Source (w/o annotations (1); see within schema source)
<xs:element name="ShowBidderNoticePreferences" type="xs:boolean"/>
ns:ShowCombinedPaymentPreferences
Type:
xs:boolean, predefined, simple content
If included and set to true, the seller's combined invoice preferences are returned in the response. These preferences are used to allow Combined Invoice orders.
XML Representation Summary
<ns:ShowCombinedPaymentPreferences>
   
Content: 
{ xs:boolean }
</ns:ShowCombinedPaymentPreferences>
XML Source (w/o annotations (1); see within schema source)
<xs:element name="ShowCombinedPaymentPreferences" type="xs:boolean"/>
ns:ShowCrossPromotionPreferences
Type:
xs:boolean, predefined, simple content
This field is deprecated.
XML Representation Summary
<ns:ShowCrossPromotionPreferences>
   
Content: 
{ xs:boolean }
</ns:ShowCrossPromotionPreferences>
XML Source (w/o annotations (1); see within schema source)
<xs:element name="ShowCrossPromotionPreferences" type="xs:boolean"/>
ns:ShowDispatchCutoffTimePreferences
Type:
xs:boolean, predefined, simple content
If included and set to true, the seller's same-day handling cutoff time is returned in DispatchCutoffTimePreference.CutoffTime.

Note: For sellers opted in to the feature that supports different order cutoff times for each business day, the order cutoff time returned in the response may not be accurate. In order for the seller to confirm the actual order cutoff time for same-day handling, that seller should view Shipping Preferences in My eBay.
XML Representation Summary
<ns:ShowDispatchCutoffTimePreferences>
   
Content: 
{ xs:boolean }
</ns:ShowDispatchCutoffTimePreferences>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="ShowDispatchCutoffTimePreferences" type="xs:boolean"/>
ns:ShoweBayPLUSPreference
Type:
xs:boolean, predefined, simple content
To determine whether a seller can offer eBay Plus in qualified listings, include this field and set it to true.

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

The eBayPLUSPreference container is returned in the response with information about each country where the seller is eligible to offer eBay Plus on listings (one eBayPLUSPreference container per country), as well as the seller's opt-in status and listing preference for each country.

Note: Currently, eBay Plus is available only to buyers in Germany and Australia. In Australia, the seller has no control/responsibility over setting the eBay Plus feature for a listing. Instead, eBay will evaluate/determine whether a listing is eligible for eBay Plus.
XML Representation Summary
<ns:ShoweBayPLUSPreference>
   
Content: 
{ xs:boolean }
</ns:ShoweBayPLUSPreference>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="ShoweBayPLUSPreference" type="xs:boolean"/>
ns:ShowEmailShipmentTrackingNumberPreference
Type:
xs:boolean, predefined, simple content
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.
XML Representation Summary
<ns:ShowEmailShipmentTrackingNumberPreference>
   
Content: 
{ xs:boolean }
</ns:ShowEmailShipmentTrackingNumberPreference>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="ShowEmailShipmentTrackingNumberPreference" type="xs:boolean"/>
ns:ShowEndOfAuctionEmailPreferences
Type:
xs:boolean, predefined, simple content
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.
XML Representation Summary
<ns:ShowEndOfAuctionEmailPreferences>
   
Content: 
{ xs:boolean }
</ns:ShowEndOfAuctionEmailPreferences>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="ShowEndOfAuctionEmailPreferences" type="xs:boolean"/>
ns:ShowGlobalShippingProgramListingPreference
Type:
xs:boolean, predefined, simple content
If included and set to true, the GlobalShippingProgramListingPreference field is returned. A returned value of true indicates that the seller's new listings will enable the Global Shipping Program by default.
XML Representation Summary
<ns:ShowGlobalShippingProgramListingPreference>
   
Content: 
{ xs:boolean }
</ns:ShowGlobalShippingProgramListingPreference>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="ShowGlobalShippingProgramListingPreference" type="xs:boolean"/>
ns:ShowGlobalShippingProgramPreference
Type:
xs:boolean, predefined, simple content
If this flag is included and set to true, the seller's preference for offering the Global Shipping Program to international buyers will be returned in OfferGlobalShippingProgramPreference.
XML Representation Summary
<ns:ShowGlobalShippingProgramPreference>
   
Content: 
{ xs:boolean }
</ns:ShowGlobalShippingProgramPreference>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="ShowGlobalShippingProgramPreference" type="xs:boolean"/>
ns:ShowOutOfStockControlPreference
Type:
xs:boolean, predefined, simple content
If included and set to true, the seller's preferences related to the Out-of-Stock feature will be returned. This feature is set using the SetUserPreferences call.
XML Representation Summary
<ns:ShowOutOfStockControlPreference>
   
Content: 
{ xs:boolean }
</ns:ShowOutOfStockControlPreference>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="ShowOutOfStockControlPreference" type="xs:boolean"/>
ns:ShowOverrideGSPServiceWithIntlServicePreference
Type:
xs:boolean, predefined, simple content
If included and set to true, the OverrideGSPServiceWithIntlServicePreference field is returned. A returned value of true indicates that for the seller's listings that specify an international shipping service for any Global Shipping-eligible country, the specified service will take precedence and be the listing's default international shipping option for buyers in that country, rather than the Global Shipping Program.

A returned value of false indicates that the Global Shipping program will take precedence over any international shipping service as the default option in Global Shipping-eligible listings for shipping to any Global Shipping-eligible country.
XML Representation Summary
<ns:ShowOverrideGSPServiceWithIntlServicePreference>
   
Content: 
{ xs:boolean }
</ns:ShowOverrideGSPServiceWithIntlServicePreference>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="ShowOverrideGSPServiceWithIntlServicePreference" type="xs:boolean"/>
ns:ShowPickupDropoffPreferences
Type:
xs:boolean, predefined, simple content
If included and set to true, the PickupDropoffSellerPreference field is returned. A returned value of true indicates that the seller's new listings will by default be eligible to be evaluated for the Click and Collect feature.

With the Click and Collect feature, a buyer can purchase certain items on eBay and collect them at a local store. Buyers are notified by eBay once their items are available. The Click and Collect feature is only available to large merchants on the eBay UK (site ID 3), eBay Australia (Site ID 15), and eBay Germany (Site ID 77) sites.

Note: The Click and Collect program no longer allows sellers to set the Click and Collect preference at the listing level.
XML Representation Summary
<ns:ShowPickupDropoffPreferences>
   
Content: 
{ xs:boolean }
</ns:ShowPickupDropoffPreferences>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="ShowPickupDropoffPreferences" type="xs:boolean"/>
ns:ShowProStoresPreferences
Type:
xs:boolean, predefined, simple content
This field is deprecated.
XML Representation Summary
<ns:ShowProStoresPreferences>
   
Content: 
{ xs:boolean }
</ns:ShowProStoresPreferences>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="ShowProStoresPreferences" type="xs:boolean"/>
ns:ShowPurchaseReminderEmailPreferences
Type:
xs:boolean, predefined, simple content
If included and set to true, the seller's preference for sending a purchase reminder email to buyers is returned in the response.
XML Representation Summary
<ns:ShowPurchaseReminderEmailPreferences>
   
Content: 
{ xs:boolean }
</ns:ShowPurchaseReminderEmailPreferences>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="ShowPurchaseReminderEmailPreferences" type="xs:boolean"/>
ns:ShowRequiredShipPhoneNumberPreference
Type:
xs:boolean, predefined, simple content
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.
XML Representation Summary
<ns:ShowRequiredShipPhoneNumberPreference>
   
Content: 
{ xs:boolean }
</ns:ShowRequiredShipPhoneNumberPreference>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="ShowRequiredShipPhoneNumberPreference" type="xs:boolean"/>
ns:ShowSellerExcludeShipToLocationPreference
Type:
xs:boolean, predefined, simple content
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.
XML Representation Summary
<ns:ShowSellerExcludeShipToLocationPreference>
   
Content: 
{ xs:boolean }
</ns:ShowSellerExcludeShipToLocationPreference>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="ShowSellerExcludeShipToLocationPreference" type="xs:boolean"/>
ns:ShowSellerFavoriteItemPreferences
Type:
xs:boolean, predefined, simple content
If included and set to true, the seller's favorite item preferences are returned in the response.
XML Representation Summary
<ns:ShowSellerFavoriteItemPreferences>
   
Content: 
{ xs:boolean }
</ns:ShowSellerFavoriteItemPreferences>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="ShowSellerFavoriteItemPreferences" type="xs:boolean"/>
ns:ShowSellerPaymentPreferences
Type:
xs:boolean, predefined, simple content
If included and set to true, the seller's payment preferences are returned in the response.
XML Representation Summary
<ns:ShowSellerPaymentPreferences>
   
Content: 
{ xs:boolean }
</ns:ShowSellerPaymentPreferences>
XML Source (w/o annotations (1); see within schema source)
<xs:element name="ShowSellerPaymentPreferences" type="xs:boolean"/>
ns:ShowSellerProfilePreferences
Type:
xs:boolean, predefined, simple content
If this flag is included and set to true, the seller's Business Policies profile information is returned in the response. This information includes a flag that indicates whether or not the seller has opted into Business Policies, as well as Business Policies profiles (payment, shipping, and return policy) active on the seller's account.
XML Representation Summary
<ns:ShowSellerProfilePreferences>
   
Content: 
{ xs:boolean }
</ns:ShowSellerProfilePreferences>
XML Source (w/o annotations (1); see within schema source)
<xs:element name="ShowSellerProfilePreferences" type="xs:boolean"/>
ns:ShowSellerReturnPreferences
Type:
xs:boolean, predefined, simple content
If this flag is included and set to true, the SellerReturnPreferences container is returned in the response and indicates whether or not the seller has opted in to eBay Managed Returns.

eBay Managed Returns are currently only available on the US, UK, DE, AU, and CA (English and French) sites.
XML Representation Summary
<ns:ShowSellerReturnPreferences>
   
Content: 
{ xs:boolean }
</ns:ShowSellerReturnPreferences>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="ShowSellerReturnPreferences" type="xs:boolean"/>
ns:ShowUnpaidItemAssistanceExclusionList
Type:
xs:boolean, predefined, simple content
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.
XML Representation Summary
<ns:ShowUnpaidItemAssistanceExclusionList>
   
Content: 
{ xs:boolean }
</ns:ShowUnpaidItemAssistanceExclusionList>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="ShowUnpaidItemAssistanceExclusionList" type="xs:boolean"/>
ns:ShowUnpaidItemAssistancePreference
Type:
xs:boolean, predefined, simple content
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.
XML Representation Summary
<ns:ShowUnpaidItemAssistancePreference>
   
Content: 
{ xs:boolean }
</ns:ShowUnpaidItemAssistancePreference>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="ShowUnpaidItemAssistancePreference" type="xs:boolean"/>
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.