Inherits from Trading_AbstractResponseType : NSObject
Declared in Trading_GetUserPreferencesResponseType.h
Trading_GetUserPreferencesResponseType.m

Overview

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.

@ingroup EBayAPIInterface

Tasks

  •   bidderNoticePreferences

    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.

    property
  •   combinedPaymentPreferences

    Container consisting of the seller’s combined payment preferences. This
    container is returned when ShowCombinedPaymentPreferences
    is included and set to ‘true’ in the request.


    Note:
    Calculated and flat-rate shipping preferences are no longer managed using the
    SetUserPreferences and GetUserPreferences calls.
    Instead,use the
    SetDiscountProfiles and GetDiscountProfiles
    calls to manage shipping discounts for combined payment orders.

    property
  •   crossPromotionPreferences

    This container is no longer supported 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.



    Container consisting of the seller’s cross-promotion preferences. This
    container is returned when ShowCrossPromotionPreferences is
    included and set to ‘true’ in the request. These preferences are only applicable
    for eBay Store owners.

    property
  •   sellerPaymentPreferences

    Container consisting of the seller’s payment preferences. This container is
    returned when ShowSellerPaymentPreferences is included and
    set to ‘true’ in the request.

    property
  •   sellerFavoriteItemPreferences

    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.

    property
  •   endOfAuctionEmailPreferences

    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.

    property
  •   emailShipmentTrackingNumberPreference

    Container consisting of the seller’s preference for sending an email to the
    buyer with the shipping tracking number. This container is returned when
    ShowEmailShipmentTrackingNumberPreference is included and set
    to ‘true’ in the request.

    property
  •   requiredShipPhoneNumberPreference

    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.

    property
  •   proStoresPreference

    Container consisting of the seller’s ProStores preferences. This container
    is returned when ShowProStoresPreference is included and
    set to ‘true’ in the request.

    property
  •   unpaidItemAssistancePreferences

    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.

    property
  •   sellerExcludeShipToLocationPreferences

    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.

    property
  •   purchaseReminderEmailPreferences

    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.

    property
  •   sellerThirdPartyCheckoutDisabled

    This flag is set with the
    SellerThirdPartyCheckoutDisabled field of the
    SetUserPreferences call, and is used to disable the
    use of a third-party application to handle the checkout flow for a seller.
    If true, Third-Party Checkout is disabled and any checkout flow initiated on
    the seller’s application is redirected to the eBay checkout flow. This field
    is only returned if the SellerThirdPartyCheckoutDisabled
    field has been set with the SetUserPreferences call.

    property
  •   sellerProfilePreferences

    Parent response container consisting of high-level information for all
    Business Policies profiles 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 profiles are defined for the user’s account).



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

    property
  •   sellerReturnPreferences

    Container consisting of a seller’s eBay Return Center preferences. This
    container is returned if ShowSellerReturnPreferences is
    included and set to true in the request.

    property
  •   offerGlobalShippingProgramPreference

    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.

    property

Properties

bidderNoticePreferences

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.

@property (nonatomic, retain) Trading_BidderNoticePreferencesType *bidderNoticePreferences

Discussion

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.

type : class Trading_BidderNoticePreferencesType

Declared In

Trading_GetUserPreferencesResponseType.h

combinedPaymentPreferences

Container consisting of the seller’s combined payment preferences. This
container is returned when ShowCombinedPaymentPreferences
is included and set to ‘true’ in the request.


Note:
Calculated and flat-rate shipping preferences are no longer managed using the
SetUserPreferences and GetUserPreferences calls.
Instead,use the
SetDiscountProfiles and GetDiscountProfiles
calls to manage shipping discounts for combined payment orders.

@property (nonatomic, retain) Trading_CombinedPaymentPreferencesType *combinedPaymentPreferences

Discussion

Container consisting of the seller’s combined payment preferences. This
container is returned when ShowCombinedPaymentPreferences
is included and set to ‘true’ in the request.


Note:
Calculated and flat-rate shipping preferences are no longer managed using the
SetUserPreferences and GetUserPreferences calls.
Instead,use the
SetDiscountProfiles and GetDiscountProfiles
calls to manage shipping discounts for combined payment orders.

type : class Trading_CombinedPaymentPreferencesType

Declared In

Trading_GetUserPreferencesResponseType.h

crossPromotionPreferences

This container is no longer supported 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.



Container consisting of the seller’s cross-promotion preferences. This
container is returned when ShowCrossPromotionPreferences is
included and set to ‘true’ in the request. These preferences are only applicable
for eBay Store owners.

@property (nonatomic, retain) Trading_CrossPromotionPreferencesType *crossPromotionPreferences

Discussion

This container is no longer supported 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.



Container consisting of the seller’s cross-promotion preferences. This
container is returned when ShowCrossPromotionPreferences is
included and set to ‘true’ in the request. These preferences are only applicable
for eBay Store owners.

type : class Trading_CrossPromotionPreferencesType

Declared In

Trading_GetUserPreferencesResponseType.h

emailShipmentTrackingNumberPreference

Container consisting of the seller’s preference for sending an email to the
buyer with the shipping tracking number. This container is returned when
ShowEmailShipmentTrackingNumberPreference is included and set
to ‘true’ in the request.

@property (nonatomic, retain) NSNumber *emailShipmentTrackingNumberPreference

Discussion

Container consisting of the seller’s preference for sending an email to the
buyer with the shipping tracking number. This container is returned when
ShowEmailShipmentTrackingNumberPreference is included and set
to ‘true’ in the request.

type : NSNumber, wrapper for primitive bool

Declared In

Trading_GetUserPreferencesResponseType.h

endOfAuctionEmailPreferences

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.

@property (nonatomic, retain) Trading_EndOfAuctionEmailPreferencesType *endOfAuctionEmailPreferences

Discussion

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.

type : class Trading_EndOfAuctionEmailPreferencesType

Declared In

Trading_GetUserPreferencesResponseType.h

offerGlobalShippingProgramPreference

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.

@property (nonatomic, retain) NSNumber *offerGlobalShippingProgramPreference

Discussion

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.

type : NSNumber, wrapper for primitive bool

Declared In

Trading_GetUserPreferencesResponseType.h

proStoresPreference

Container consisting of the seller’s ProStores preferences. This container
is returned when ShowProStoresPreference is included and
set to ‘true’ in the request.

@property (nonatomic, retain) Trading_ProStoresCheckoutPreferenceType *proStoresPreference

Discussion

Container consisting of the seller’s ProStores preferences. This container
is returned when ShowProStoresPreference is included and
set to ‘true’ in the request.

type : class Trading_ProStoresCheckoutPreferenceType

Declared In

Trading_GetUserPreferencesResponseType.h

purchaseReminderEmailPreferences

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.

@property (nonatomic, retain) Trading_PurchaseReminderEmailPreferencesType *purchaseReminderEmailPreferences

Discussion

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.

type : class Trading_PurchaseReminderEmailPreferencesType

Declared In

Trading_GetUserPreferencesResponseType.h

requiredShipPhoneNumberPreference

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.

@property (nonatomic, retain) NSNumber *requiredShipPhoneNumberPreference

Discussion

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.

type : NSNumber, wrapper for primitive bool

Declared In

Trading_GetUserPreferencesResponseType.h

sellerExcludeShipToLocationPreferences

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.

@property (nonatomic, retain) Trading_SellerExcludeShipToLocationPreferencesType *sellerExcludeShipToLocationPreferences

Discussion

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.

type : class Trading_SellerExcludeShipToLocationPreferencesType

Declared In

Trading_GetUserPreferencesResponseType.h

sellerFavoriteItemPreferences

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.

@property (nonatomic, retain) Trading_SellerFavoriteItemPreferencesType *sellerFavoriteItemPreferences

Discussion

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.

type : class Trading_SellerFavoriteItemPreferencesType

Declared In

Trading_GetUserPreferencesResponseType.h

sellerPaymentPreferences

Container consisting of the seller’s payment preferences. This container is
returned when ShowSellerPaymentPreferences is included and
set to ‘true’ in the request.

@property (nonatomic, retain) Trading_SellerPaymentPreferencesType *sellerPaymentPreferences

Discussion

Container consisting of the seller’s payment preferences. This container is
returned when ShowSellerPaymentPreferences is included and
set to ‘true’ in the request.

type : class Trading_SellerPaymentPreferencesType

Declared In

Trading_GetUserPreferencesResponseType.h

sellerProfilePreferences

Parent response container consisting of high-level information for all
Business Policies profiles 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 profiles are defined for the user’s account).



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

@property (nonatomic, retain) Trading_SellerProfilePreferencesType *sellerProfilePreferences

Discussion

Parent response container consisting of high-level information for all
Business Policies profiles 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 profiles are defined for the user’s account).



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

type : class Trading_SellerProfilePreferencesType

Declared In

Trading_GetUserPreferencesResponseType.h

sellerReturnPreferences

Container consisting of a seller’s eBay Return Center preferences. This
container is returned if ShowSellerReturnPreferences is
included and set to true in the request.

@property (nonatomic, retain) Trading_SellerReturnPreferencesType *sellerReturnPreferences

Discussion

Container consisting of a seller’s eBay Return Center preferences. This
container is returned if ShowSellerReturnPreferences is
included and set to true in the request.

type : class Trading_SellerReturnPreferencesType

Declared In

Trading_GetUserPreferencesResponseType.h

sellerThirdPartyCheckoutDisabled

This flag is set with the
SellerThirdPartyCheckoutDisabled field of the
SetUserPreferences call, and is used to disable the
use of a third-party application to handle the checkout flow for a seller.
If true, Third-Party Checkout is disabled and any checkout flow initiated on
the seller’s application is redirected to the eBay checkout flow. This field
is only returned if the SellerThirdPartyCheckoutDisabled
field has been set with the SetUserPreferences call.

@property (nonatomic, retain) NSNumber *sellerThirdPartyCheckoutDisabled

Discussion

This flag is set with the
SellerThirdPartyCheckoutDisabled field of the
SetUserPreferences call, and is used to disable the
use of a third-party application to handle the checkout flow for a seller.
If true, Third-Party Checkout is disabled and any checkout flow initiated on
the seller’s application is redirected to the eBay checkout flow. This field
is only returned if the SellerThirdPartyCheckoutDisabled
field has been set with the SetUserPreferences call.

type : NSNumber, wrapper for primitive bool

Declared In

Trading_GetUserPreferencesResponseType.h

unpaidItemAssistancePreferences

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.

@property (nonatomic, retain) Trading_UnpaidItemAssistancePreferencesType *unpaidItemAssistancePreferences

Discussion

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.

type : class Trading_UnpaidItemAssistancePreferencesType

Declared In

Trading_GetUserPreferencesResponseType.h