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:SetUserPreferencesRequestType"
Namespace:
urn:ebay:apis:eBLBaseComponents
Content:
complex, 25 elements, elem. wildcard
Defined:
globally in Schema in ebaySvc.wsdl; see XML source
Includes:
definitions of 15 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:BidderNoticePreferences?, ns:CombinedPaymentPreferences?, ns:CrossPromotionPreferences?, ns:SellerPaymentPreferences?, ns:SellerFavoriteItemPreferences?, ns:EndOfAuctionEmailPreferences?, ns:EmailShipmentTrackingNumberPreference?, ns:RequiredShipPhoneNumberPreference?, ns:UnpaidItemAssistancePreferences?, ns:PurchaseReminderEmailPreferences?, ns:SellerThirdPartyCheckoutDisabled?, ns:DispatchCutoffTimePreference?, ns:GlobalShippingProgramListingPreference?, ns:OverrideGSPserviceWithIntlService?, ns:OutOfStockControlPreference?
</...>
All Direct / Indirect Based Elements (1):
ns:SetUserPreferencesRequest
Known Usage Locations
Annotation
This call allows an eBay user to set/modify numerous seller account preferences.
Type Definition Detail
Type Derivation Tree
ns:AbstractRequestType (extension)
  ns:SetUserPreferencesRequestType
XML Source (w/o annotations (16); see within schema source)
<xs:complexType name="SetUserPreferencesRequestType">
<xs:complexContent>
<xs:extension base="ns:AbstractRequestType">
<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="SellerThirdPartyCheckoutDisabled" 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="OverrideGSPserviceWithIntlService" type="xs:boolean"/>
<xs:element minOccurs="0" name="OutOfStockControlPreference" type="xs:boolean"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
Content Element Detail (all declarations defined in this component; 15/26)
ns:BidderNoticePreferences
Type:
ns:BidderNoticePreferencesType, complex content
This container is included if the seller wishes to receive contact information for unsuccessful bidders. 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
This container is included if the seller wishes to set the preference for allowing Combined Invoice orders for cases where the buyer has multiple unpaid order line items from the same seller.
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
This container is included if the seller wishes to set/modify the order cut off time for same-day shipping. If the seller specifies a value of 0 in Item.DispatchTimeMax to offer same day handling when listing an item, the seller's shipping time commitment depends on the order cut off time set for the listing site, as indicated by the DispatchCutoffTimePreference.CutoffTime field.

Note: For sellers opted in to the feature that supports different order cut off times for each business day, this container cannot be used to change the order cut off for one or more business days. If this container is used, it will have no effect on any of the order cut off times configured for the seller. In order for the seller to change and/or confirm the actual order cutoff times for same-day handling, that seller should go to 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:EmailShipmentTrackingNumberPreference
Type:
xs:boolean, predefined, simple content
This field is included and set to true if the seller wishes to email the shipment's tracking number to the buyer.
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
This container is included if the seller wishes to set preferences for the end-of-auction email sent to the winning bidder. These preferences allow the seller to customize the Email that is sent to buyer at the end of the auction. One or more preferences may be set or modified under this container. 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 this flag is included and set to true, the seller's new listings will enable the Global Shipping Program by default.

Note: This field is ignored for sellers who are not opted in to the Global Shipping Program (when GetUserPreferences returns OfferGlobalShippingProgramPreference with a value of false).
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:OutOfStockControlPreference
Type:
xs:boolean, predefined, simple content
If this flag is included and set to true, it enables the Out-of-Stock feature. A seller would use this feature to keep Fixed-Price GTC (Good 'Til Canceled) listings alive even when the "quantity available" value goes to 0 (zero). This is useful when waiting for additional stock and eliminates the need to end the listing and then recreating it when stock arrives.

While the "quantity available" value is 0, the listing would be hidden from eBay search and if that item was specifically searched for with GetItem (or related call), the element HideFromSearch would be returned as 'true' and ReasonHideFromSearch would be returned as 'OutOfStock'.

When stock is available, the seller can use the Revise calls to update the inventory of the item (through the Item.Quantity or Item.Variations.Variation.Quantity fields) and the listing would appear again.

You can return the value of this flag using the GetUserPreferences call and setting the ShowOutOfStockControlPreference field to 'true'.

IMPORTANT: When a listing using the Out-of-Stock feature has zero quantity, the seller has 90 days to add inventory without incurring a listing fee. Fees are changed at the end of each the billing cycle but are then refunded if the item is out-of-stock for an entire billing period. See Fees For a Listing With Zero Quantity for details.
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:OverrideGSPserviceWithIntlService
Type:
xs:boolean, predefined, simple content
If this flag is included and set to true, and the seller specifies an international shipping service to a particular country for a given listing, 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. The Global Shipping Program will still be the listing's default option for shipping to any Global Shipping-eligible country for which the seller does not specify an international shipping service.

If this flag is set to false, the Global Shipping Program will be each Global Shipping-eligible listing's default option for shipping to any Global Shipping-eligible country, regardless of any international shipping service that the seller specifies for the listing.
XML Representation Summary
<ns:OverrideGSPserviceWithIntlService>
   
Content: 
{ xs:boolean }
</ns:OverrideGSPserviceWithIntlService>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="OverrideGSPserviceWithIntlService" type="xs:boolean"/>
ns:PurchaseReminderEmailPreferences
Type:
ns:PurchaseReminderEmailPreferencesType, complex content
This container is included if the seller wishes to set the preference for sending a purchase reminder email to buyers.
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
This field is included and set to true if the seller wishes to require the buyer to provide a shipping phone number upon checkout. Some shipping carriers require the receiver's phone number.
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:SellerFavoriteItemPreferences
Type:
ns:SellerFavoriteItemPreferencesType, complex content
This container is included if the seller wishes to set preferences for displaying items on a buyer's Favorite Sellers' Items page or Favorite Sellers' Items digest. One or more preferences may be set or modified under this container.
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
This container is included if the seller wishes to set various payment preferences. One or more preferences may be set or modified under this container. Payment preferences specified in a SetUserPreferences call override the settings in My eBay payment preferences.
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:SellerThirdPartyCheckoutDisabled
Type:
xs:boolean, predefined, simple content
This field is no longer applicable, as third-party checkout on eBay is no longer possible.
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
This container is included if the seller wishes to set Unpaid Item Assistant preferences. The Unpaid Item Assistant automatically opens an Unpaid Item case on the behalf of the seller if the buyer has not paid for the order after a specified number of days. One or more preferences may be set or modified under this container.
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.