eBay Trading APIVersion 1131

MyeBayFavoriteSearchType

Type defining the FavoriteSearch container returned in GetMyeBayBuying. The FavoriteSearch container consists of options and filtering used in a buyer's Saved Search on My eBay, and is only returned in GetMyeBayBuying if the FavoriteSearches container is included the request, and if there is at least one Saved Search for the buyer.

Type that uses MyeBayFavoriteSearchType:

Call that uses MyeBayFavoriteSearchType:

Fields



BidCountMax ( int ) [0..1]
The BidCountMax value in a My eBay Favorite Search. The BidCountMax limits the search results to items with a maximum number of bids.
See the Field Index to learn which calls use BidCountMax.

BidCountMin ( int ) [0..1]
The BidCountMin value in a My eBay Favorite Search. The BidCountMin limits the results of a search to items with a maximum number of bids.
See the Field Index to learn which calls use BidCountMin.

CategoryID ( string ) [0..1]
This is the unique identifier (Category ID) of the category in which the user was searching for the item for the Saved Search. Specifying a category in a query restricts the search to a specific category. If the Saved Search is not restricted to a specific category, the CategoryID field will not appear in the request.
See the Field Index to learn which calls use CategoryID.

The Condition value in a My eBay Favorite Search. Condition limits the results to new or used items, plus items that have no condition specified.
See the Field Index to learn which calls use Condition.

Currency ( CurrencyCodeType ) [0..1]
The appearance of a Currency value indicates that a currency filter has been specified in the Saved Search. Only listings with the specified Currency value are retrieved in the search results.
See the Field Index to learn which calls use Currency.

EndTimeFrom ( dateTime ) [0..1]
The EndTimeFrom and EndTimeFrom values indicates that a date range has been specified in the Saved Search. Only listings ending during the date range defined with the EndTimeFrom and EndTimeFrom values are retrieved in the search results.

The EndTimeFrom value indicates the beginning of the date range.
See the Field Index to learn which calls use EndTimeFrom.

EndTimeTo ( dateTime ) [0..1]
The appearance of EndTimeFrom and EndTimeFrom values in the response indicates that a date range has been specified in the Saved Search. Only listings ending during the date range defined with the EndTimeFrom and EndTimeFrom values are retrieved in the search results.

The EndTimeTo value indicates the ending of the date range.
See the Field Index to learn which calls use EndTimeTo.

ItemsAvailableTo ( CountryCodeType ) [0..1]
The ItemsAvailableTo value in a My eBay Favorite Search. ItemsAvailableTo limits the result set to just those items available to the specified country.
See the Field Index to learn which calls use ItemsAvailableTo.

ItemsLocatedIn ( CountryCodeType ) [0..1]
The ItemsLocatedIn value in a My eBay Favorite Search. ItemsLocatedIn limits the result set to just those items located in the specified country.
See the Field Index to learn which calls use ItemsLocatedIn.

This enumeration value indicates the "Sort by" value that the user specified in the Saved Search. Some of the ways buyers can sort items include by Best Match (generally, the default), item price, item price + shipping, listing end time, and item distance (relative to the buyer's shipping address). Available sort values may vary for each search, but below is the complete set of values that may be returned in this field.
See the Field Index to learn which calls use ItemSort.

ItemType ( ItemTypeCodeType ) [0..1]
Enumerated value that provides more information on the type of listing type filtering the buyer used when setting up a Saved Search in My eBay.
See the Field Index to learn which calls use ItemType.

MaxDistance ( int ) [0..1]
The appearance of a MaxDistance value in the response indicates that a proximity (Items near me) filter has been specified in the Saved Search.

The MaxDistance value is the maximum distance (in miles) away from the buyer's postal code (specified or default) that an item may be located (based on the PostalCode value returned in the FavoriteSearch container). In a Saved Search, a buyer can supply a postal code or can base that postal code on a major city. If neither one of these methods for selecting a postal code is used, the postal code defaults to the buyer's primary shipping address. Only items located within the MaxDistance value are returned in the search results.
See the Field Index to learn which calls use MaxDistance.

PaymentMethod ( PaymentMethodSearchCodeType ) [0..1]
Not used by any call.

This field is no longer applicable, as filtering by a payment method in an advanced item search is no longer supported/applicable.
See the Field Index to learn which calls use PaymentMethod.

PostalCode ( string ) [0..1]
The PostalCode value is either the postal code for the buyer's primary shipping address, or it is the postal code specified through the proximity (Items near me) filter of a Saved Search. In a Saved Search, a buyer can supply a postal code or can base that postal code on a major city.
See the Field Index to learn which calls use PostalCode.

PreferredLocation ( PreferredLocationCodeType ) [0..1]
The PreferredLocation value of a My eBay Favorite Search. The PreferredLocation specifies the criteria for filtering search results by site, where site is determined by the site ID in the request.
See the Field Index to learn which calls use PreferredLocation.

PriceMax ( AmountType (double) ) [0..1]
The appearance of a PriceMax value indicates that a maximum price filter has been specified in the Saved Search. Only listings with an item price at or below the PriceMax value are retrieved in the search results.

PriceMax can be used in conjunction with PriceMin in a Saved Search to specify a price range. Only listings with item prices within this price range are retrieved in the search results.
See the Field Index to learn which calls use PriceMax.

PriceMin ( AmountType (double) ) [0..1]
The appearance of a PriceMin value indicates that a minimum price filter has been specified in the Saved Search. Only listings with an item price at or above the PriceMin value are retrieved in the search results.

PriceMin can be used in conjunction with PriceMax in a Saved Search to specify a price range. Only listings with item prices within this price range are retrieved in the search results.
See the Field Index to learn which calls use PriceMin.

Quantity ( int ) [0..1]
The Quantity value in a My eBay Favorite Search. The Quantity limits the search results to listings that offer a certain number of items matching the query. The Quantity field is used with QuantityOperator to specify that you are seeking listings with quantities greater than, equal to, or less than the value you specify in Quantity.
See the Field Index to learn which calls use Quantity.

QuantityOperator ( QuantityOperatorCodeType ) [0..1]
The Quantity Operator value in a My eBay Favorite Search. The Quantity Operator limits the results to listings with quantities greater than, equal to, or less than the value you specify in Quantity.
See the Field Index to learn which calls use QuantityOperator.

QueryKeywords ( string ) [0..1]
This string is the original search string of the buyer's Saved Search on My eBay. This is the string that the user input into the search field.
See the Field Index to learn which calls use QueryKeywords.

SearchFlag ( SearchFlagCodeType ) [0..*]
The SearchFlag value in a My eBay Favorite Search. The SearchFlag allows you to specify whether you want to include charity listings, free-shipping listings, and listings with other features in your search.
See the Field Index to learn which calls use SearchFlag.

SearchName ( string ) [0..1]
The name of the buyer's Saved Search on My eBay. The name defaults to the user's original search string, or the user has the option of modifying the name of the Saved Search.
See the Field Index to learn which calls use SearchName.

SearchQuery ( string ) [0..1]
This is the URL of the buyer's Saved Search on My eBay.
See the Field Index to learn which calls use SearchQuery.

SellerBusinessType ( SellerBusinessCodeType ) [0..1]
The SellerBusinessType value in a My eBay Favorite Search. The SellerBusinessType limits the search results to those of a particular seller business type such as commercial or private. SellerBusinessType is only available for sites that have business seller features enabled.
See the Field Index to learn which calls use SellerBusinessType.

SellerID ( string ) [0..*]
The SellerID value in a My eBay Favorite Search. The SellerID is the eBay ID of a specific seller.
See the Field Index to learn which calls use SellerID.

SellerIDExclude ( string ) [0..*]
The SellerIDExclude value in a My eBay Favorite Search. The SellerIDExclude limits the search results to exclude items sold by a specific seller or by specific sellers.
See the Field Index to learn which calls use SellerIDExclude.

SortOrder ( SortOrderCodeType ) [0..1]
The SortOrder value works in conjunction with the ItemSort value, and indicates whether Saved Search results are returned in ascending (low to high values) or descending (high to low values) order.
See the Field Index to learn which calls use SortOrder.