eBay Trading API
Version 1359


complexType "SetUserPreferencesRequestType"
Namespace:
urn:ebay:apis:eBLBaseComponents
Derived By:
extension of AbstractRequestType
Content:
complex, 23 elements, elem. wildcard
Defined:
in ebaySvc.wsdl/Schema
Includes:
declarations of 13 elements
Referenced:
Component Diagram

Content Element Model:
Component
Type / Value
Occurs
Required?
Nillable?
Description
SEQUENCE
1..1
yes
DetailLevelCodeType : enumeration of token
0..∞
no
no
Detail levels are instructions that define standard subsets of data to return for particular data components (e.g., each Item, Transaction, or User) within the response payload. »
string
0..1
no
no
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. »
string
0..1
no
no
Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. »
string
0..1
no
no
The version number of the API code that you are programming against (e.g., 1149). »
string
0..1
no
no
The public IP address of the machine from which the request is sent. »
ErrorHandlingCodeType : enumeration of token
0..1
no
no
Error tolerance level for the call. »
UUIDType : restriction of string
0..1
no
no
A unique identifier for a particular call. »
string
0..∞
no
no
You can use the OutputSelector field to restrict the data returned by a call. »
WarningLevelCodeType : enumeration of token
0..1
no
no
Controls whether or not to return warnings when the application passes unrecognized or deprecated elements in a request. »
0..1
no
no
This container is only used by the PlaceOffer call request if the previous PlaceOffer call resulted in a BotBlock container in the response. »
from any namespace
0..∞
no
 BidderNoticePreferences
0..1
no
no
This container is included if the seller wishes to receive contact information for unsuccessful bidders. This preference is only applicable for auction listings.
 CombinedPaymentPreferences
0..1
no
no
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.
 SellerPaymentPreferences
0..1
no
no
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.
 SellerFavoriteItemPreferences
0..1
no
no
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.
 EndOfAuctionEmailPreferences
0..1
no
no
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.
 EmailShipmentTrackingNumberPreference
boolean
0..1
no
no
This field is included and set to true if the seller wishes to email the shipment's tracking number to the buyer.
 RequiredShipPhoneNumberPreference
boolean
0..1
no
no
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.
 UnpaidItemAssistancePreferences
0..1
no
no
This container is included if the seller wishes to set or modify Unpaid Item preferences. The Unpaid Item preferences 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.
 PurchaseReminderEmailPreferences
0..1
no
no
This container is included if the seller wishes to set the preference for sending a purchase reminder email to buyers.
 DispatchCutoffTimePreference
0..1
no
no
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.
 GlobalShippingProgramListingPreference
boolean
0..1
no
no
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).
 OverrideGSPserviceWithIntlService
boolean
0..1
no
no
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.
 OutOfStockControlPreference
boolean
0..1
no
no
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.
Description
This call allows an eBay user to set/modify numerous seller account preferences.
Referenced By
Type Definition Detail
Type Derivation Tree
AbstractRequestType (extension)
  SetUserPreferencesRequestType


WSDL documentation generated with FlexDoc/XML 1.14 using FlexDoc/XML WSDLDoc 2.0 template set. All XSD diagrams generated by FlexDoc/XML DiagramKit.