Inherits from Trading_AbstractRequestType : NSObject
Declared in Trading_GetUserPreferencesRequestType.h
Trading_GetUserPreferencesRequestType.m

Overview

Retrieves the specified user preferences for the authenticated caller.

@ingroup EBayAPIInterface

Tasks

  •   showBidderNoticePreferences

    If included and set to true, the seller’s preference for receiving contact
    information for unsuccessful bidders is returned in the response.

    property
  •   showCombinedPaymentPreferences

    If included and set to true, the seller’s combined payment preferences are
    returned in the response.



    Note:
    The CombinedPaymentPreferences.CombinedPaymentOption field is the only
    preference that should be managed with the GetUserPreferences and
    SetUserPreferences calls. All other Combined Payment preferences should be
    managed with the SetDiscountProfiles and GetDiscountProfiles calls.

    property
  •   showCrossPromotionPreferences

    This container should no longer be used as eBay Store Cross Promotions are no
    longer supported in the Trading API. This container will be removed from the
    Trading WSDL and API Call Reference docs in a future release.



    If included and set to true, the seller’s cross-promotion preferences are
    returned in the response. These preferences are only applicable for eBay
    Store owners.

    property
  •   showSellerPaymentPreferences

    If included and set to true, the seller’s payment preferences are returned
    in the response.

    property
  •   showEndOfAuctionEmailPreferences

    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.

    property
  •   showSellerFavoriteItemPreferences

    If included and set to true, the seller’s favorite item preferences are
    returned in the response.

    property
  •   showProStoresPreferences

    If included and set to true, the seller’s ProStores preferences are
    returned in the response.

    property
  •   showEmailShipmentTrackingNumberPreference

    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.

    property
  •   showRequiredShipPhoneNumberPreference

    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.

    property
  •   showSellerExcludeShipToLocationPreference

    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.

    property
  •   showUnpaidItemAssistancePreference

    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.

    property
  •   showPurchaseReminderEmailPreferences

    If included and set to true, the seller’s preference for sending a purchase
    reminder email to buyers is returned in the response.

    property
  •   showUnpaidItemAssistanceExclusionList

    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.

    property
  •   showSellerProfilePreferences

    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.



    Note:
    Business Policies are not yet available for use on the eBay platform.

    property
  •   showSellerReturnPreferences

    If this flag is included and set to true, the seller’s eBay Return Center
    preference information will be returned.



    eBay managed returns are currently only available on the US site. The eBay
    Return Center pilot launched on July 10, 2012. The eBay Return Center full
    launch is scheduled for early August 2012.

    property
  •   showGlobalShippingProgramPreference

    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.

    property

Properties

showBidderNoticePreferences

If included and set to true, the seller’s preference for receiving contact
information for unsuccessful bidders is returned in the response.

@property (nonatomic, retain) NSNumber *showBidderNoticePreferences

Discussion

If included and set to true, the seller’s preference for receiving contact
information for unsuccessful bidders is returned in the response.

type : NSNumber, wrapper for primitive bool

Declared In

Trading_GetUserPreferencesRequestType.h

showCombinedPaymentPreferences

If included and set to true, the seller’s combined payment preferences are
returned in the response.



Note:
The CombinedPaymentPreferences.CombinedPaymentOption field is the only
preference that should be managed with the GetUserPreferences and
SetUserPreferences calls. All other Combined Payment preferences should be
managed with the SetDiscountProfiles and GetDiscountProfiles calls.

@property (nonatomic, retain) NSNumber *showCombinedPaymentPreferences

Discussion

If included and set to true, the seller’s combined payment preferences are
returned in the response.



Note:
The CombinedPaymentPreferences.CombinedPaymentOption field is the only
preference that should be managed with the GetUserPreferences and
SetUserPreferences calls. All other Combined Payment preferences should be
managed with the SetDiscountProfiles and GetDiscountProfiles calls.

type : NSNumber, wrapper for primitive bool

Declared In

Trading_GetUserPreferencesRequestType.h

showCrossPromotionPreferences

This container should no longer be used as eBay Store Cross Promotions are no
longer supported in the Trading API. This container will be removed from the
Trading WSDL and API Call Reference docs in a future release.



If included and set to true, the seller’s cross-promotion preferences are
returned in the response. These preferences are only applicable for eBay
Store owners.

@property (nonatomic, retain) NSNumber *showCrossPromotionPreferences

Discussion

This container should no longer be used as eBay Store Cross Promotions are no
longer supported in the Trading API. This container will be removed from the
Trading WSDL and API Call Reference docs in a future release.



If included and set to true, the seller’s cross-promotion preferences are
returned in the response. These preferences are only applicable for eBay
Store owners.

type : NSNumber, wrapper for primitive bool

Declared In

Trading_GetUserPreferencesRequestType.h

showEmailShipmentTrackingNumberPreference

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.

@property (nonatomic, retain) NSNumber *showEmailShipmentTrackingNumberPreference

Discussion

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.

type : NSNumber, wrapper for primitive bool

Declared In

Trading_GetUserPreferencesRequestType.h

showEndOfAuctionEmailPreferences

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.

@property (nonatomic, retain) NSNumber *showEndOfAuctionEmailPreferences

Discussion

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.

type : NSNumber, wrapper for primitive bool

Declared In

Trading_GetUserPreferencesRequestType.h

showGlobalShippingProgramPreference

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.

@property (nonatomic, retain) NSNumber *showGlobalShippingProgramPreference

Discussion

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.

type : NSNumber, wrapper for primitive bool

Declared In

Trading_GetUserPreferencesRequestType.h

showProStoresPreferences

If included and set to true, the seller’s ProStores preferences are
returned in the response.

@property (nonatomic, retain) NSNumber *showProStoresPreferences

Discussion

If included and set to true, the seller’s ProStores preferences are
returned in the response.

type : NSNumber, wrapper for primitive bool

Declared In

Trading_GetUserPreferencesRequestType.h

showPurchaseReminderEmailPreferences

If included and set to true, the seller’s preference for sending a purchase
reminder email to buyers is returned in the response.

@property (nonatomic, retain) NSNumber *showPurchaseReminderEmailPreferences

Discussion

If included and set to true, the seller’s preference for sending a purchase
reminder email to buyers is returned in the response.

type : NSNumber, wrapper for primitive bool

Declared In

Trading_GetUserPreferencesRequestType.h

showRequiredShipPhoneNumberPreference

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.

@property (nonatomic, retain) NSNumber *showRequiredShipPhoneNumberPreference

Discussion

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.

type : NSNumber, wrapper for primitive bool

Declared In

Trading_GetUserPreferencesRequestType.h

showSellerExcludeShipToLocationPreference

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.

@property (nonatomic, retain) NSNumber *showSellerExcludeShipToLocationPreference

Discussion

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.

type : NSNumber, wrapper for primitive bool

Declared In

Trading_GetUserPreferencesRequestType.h

showSellerFavoriteItemPreferences

If included and set to true, the seller’s favorite item preferences are
returned in the response.

@property (nonatomic, retain) NSNumber *showSellerFavoriteItemPreferences

Discussion

If included and set to true, the seller’s favorite item preferences are
returned in the response.

type : NSNumber, wrapper for primitive bool

Declared In

Trading_GetUserPreferencesRequestType.h

showSellerPaymentPreferences

If included and set to true, the seller’s payment preferences are returned
in the response.

@property (nonatomic, retain) NSNumber *showSellerPaymentPreferences

Discussion

If included and set to true, the seller’s payment preferences are returned
in the response.

type : NSNumber, wrapper for primitive bool

Declared In

Trading_GetUserPreferencesRequestType.h

showSellerProfilePreferences

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.



Note:
Business Policies are not yet available for use on the eBay platform.

@property (nonatomic, retain) NSNumber *showSellerProfilePreferences

Discussion

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.



Note:
Business Policies are not yet available for use on the eBay platform.

type : NSNumber, wrapper for primitive bool

Declared In

Trading_GetUserPreferencesRequestType.h

showSellerReturnPreferences

If this flag is included and set to true, the seller’s eBay Return Center
preference information will be returned.



eBay managed returns are currently only available on the US site. The eBay
Return Center pilot launched on July 10, 2012. The eBay Return Center full
launch is scheduled for early August 2012.

@property (nonatomic, retain) NSNumber *showSellerReturnPreferences

Discussion

If this flag is included and set to true, the seller’s eBay Return Center
preference information will be returned.



eBay managed returns are currently only available on the US site. The eBay
Return Center pilot launched on July 10, 2012. The eBay Return Center full
launch is scheduled for early August 2012.

type : NSNumber, wrapper for primitive bool

Declared In

Trading_GetUserPreferencesRequestType.h

showUnpaidItemAssistanceExclusionList

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.

@property (nonatomic, retain) NSNumber *showUnpaidItemAssistanceExclusionList

Discussion

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.

type : NSNumber, wrapper for primitive bool

Declared In

Trading_GetUserPreferencesRequestType.h

showUnpaidItemAssistancePreference

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.

@property (nonatomic, retain) NSNumber *showUnpaidItemAssistancePreference

Discussion

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.

type : NSNumber, wrapper for primitive bool

Declared In

Trading_GetUserPreferencesRequestType.h