eBay Trading APIVersion 1125

UnpaidItemAssistancePreferencesType

This type defines the UnpaidItemAssistancePreferences container. This container is used in SetUserPreferences to set the preferences related to the Unpaid Item Assistant feature. The UnpaidItemAssistancePreferences container is also returned in GetUserPreferences (if the ShowUnpaidItemAssistancePreference flag is included and set to true in the request).

See the Using Unpaid Item Assistant Help topic for more information about setting up and using the Unpaid Item Assistant feature.

Types that use UnpaidItemAssistancePreferencesType:

Calls that use UnpaidItemAssistancePreferencesType:

Fields



AutoOptDonationRefund ( boolean ) [0..1]
Flag to indicate whether or not the seller wants eBay to automatically request PayPal Giving Fund donation refunds after Unpaid Item cases are opened and closed through the Unpaid Item Assistant mechanism without payment. This setting is only applicable to eBay for Charity listings.

This field is ignored if the OptInStatus flag is included and set to false in the request, or if the seller is not currently opted into the Unpaid Item Assistant feature in Unpaid Item Assistant Preferences on My eBay.
See the Field Index to learn which calls use AutoOptDonationRefund.

AutoRelist ( boolean ) [0..1]
Flag to indicate whether or not the seller wants eBay to automatically relist items after corresponding Unpaid Item cases are opened and closed through the Unpaid Item Assistant mechanism without payment. For a multiple-quantity listing, the quantity is adjusted if AutoRelist is set to true.

This field is ignored if the OptInStatus flag is included and set to false in the request, or if the seller is not currently opted into the Unpaid Item Assistant feature in Unpaid Item Assistant Preferences on My eBay.
See the Field Index to learn which calls use AutoRelist.

DelayBeforeOpeningDispute ( int ) [0..1]
This value indicates the number of days that should elapse before the Unpaid Item Assistant mechanism opens an Unpaid Item case on behalf of the seller. Valid values are: 4, 8, 16, 24, and 32 (days).

This field is ignored if the OptInStatus flag is included and set to false in the request, or if the seller is not currently opted into the Unpaid Item Assistant feature in Unpaid Item Assistant Preferences on My eBay.
See the Field Index to learn which calls use DelayBeforeOpeningDispute.

ExcludedUser ( string ) [0..*]
An eBay User ID for which the Unpaid Item Assistant mechanism is disabled. This field is typically used by a seller who would prefer to file an Unpaid Item dispute manually for the specified user.

One or more ExcludedUser fields are used in SetUserPreferences to add users to Unpaid Item Assistant Exclusion list. Any and all ExcludedUser fields are ignored if the OptInStatus flag is included and set to false in the request, or if the seller is not currently opted into the Unpaid Item Assistant feature in Unpaid Item Assistant Preferences on My eBay.

In GetUserPreferences, one or more ExcludedUser fields represent the current Excluded user list.
See the Field Index to learn which calls use ExcludedUser.

OptInStatus ( boolean ) [0..1]
Flag to indicate whether or not the Unpaid Item Assistant mechanism is turned on for the seller. Through the Unpaid Item Assistant mechanism, eBay can automatically file Unpaid Item cases on behalf of the seller.

The Unpaid Item Assistant feature also has options to automatically relist disputed items, to automatically request a PayPal Giving Fund donation refund (for eBay for Charity listings only), or to create an 'Exclusion list' of buyers who are not subject to the automatic filing of an Unpaid Item case.
See the Field Index to learn which calls use OptInStatus.

RemoveAllExcludedUsers ( boolean ) [0..1]
This field should be included and set to true if the seller wants to clear all users from the Unpaid Item Assistant Exclusion list. The Exclusion list can be viewed from the Unpaid Item Assistant Preferences in My eBay. Excluded users are not subject to the automatic filing of Unpaid Item cases. The seller can still open Unpaid Item cases against excluded users, but these cases must be opened manually.

Users can be added to Exclusion list through the ExcludedUser field. The RemoveAllExcludedUsers field is ignored if the OptInStatus flag is included and set to false in the request, or if the seller is not currently opted into the Unpaid Item Assistant feature in Unpaid Item Assistant Preferences on My eBay.
See the Field Index to learn which calls use RemoveAllExcludedUsers.