eBay::API::XML::DataType::MyeBayFavoriteSearchType(3)

NAME
eBay::API::XML::DataType::MyeBayFavoriteSearchType

DESCRIPTION
Characteristics of a saved My eBay Favorite Search.

SYNOPSIS

INHERITANCE
eBay::API::XML::DataType::MyeBayFavoriteSearchType inherits from the eBay::API::XML::BaseDataType class

Subroutines:

  setBidCountMax()
The BidCountMax value in a My eBay Favorite Search. The BidCountMax limits the search results to items with a maximum number of bids.

# Argument: 'xs:int'

  getBidCountMax()
  Calls: GetMyeBayBuying
  Returned: Conditionally
  Details: DetailLevel: none, ReturnSummary, ReturnAll

# Returns: 'xs:int'

  setBidCountMin()
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.

# Argument: 'xs:int'

  getBidCountMin()
  Calls: GetMyeBayBuying
  Returned: Conditionally
  Details: DetailLevel: none, ReturnSummary, ReturnAll

# Returns: 'xs:int'

  setCategoryID()
The CategoryID of a My eBay Favorite Search. CategoryID is used to restrict the query to a specific category. CategoryID cannot be used with the following input fields: EndTimeFrom, EndTimeTo, PriceMin, or PriceMax.

# Argument: 'xs:string'

  getCategoryID()
  Calls: GetMyeBayBuying
  Returned: Conditionally
  Details: DetailLevel: none, ReturnSummary, ReturnAll

# Returns: 'xs:string'

  setCondition()
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.

# Argument: 'ns:ItemConditionCodeType'

  getCondition()
  Calls: GetMyeBayBuying
  Returned: Conditionally
  Details: DetailLevel: none, ReturnSummary, ReturnAll

# Returns: 'ns:ItemConditionCodeType'

  setCurrency()
The Currency of a My eBay Favorite Search. The currency value limits the result set to just those items with a specified currency.

# Argument: 'ns:CurrencyCodeType'

  getCurrency()
  Calls: GetMyeBayBuying
  Returned: Conditionally
  Details: DetailLevel: none, ReturnSummary, ReturnAll

# Returns: 'ns:CurrencyCodeType'

  setEndTimeFrom()
The EndTimeFrom of a My eBay Favorite Search. EndTimeFrom and EndTimeTo limit the results to items ending within a time range. EndTimeFrom specifies the beginning of the time range.

# Argument: 'xs:dateTime'

  getEndTimeFrom()
  Calls: GetMyeBayBuying
  Returned: Conditionally
  Details: DetailLevel: none, ReturnSummary, ReturnAll

# Returns: 'xs:dateTime'

  setEndTimeTo()
The EndTimeTo of a My eBay Favorite Search. EndTimeFrom and EndTimeTo limit the results to items ending within a time range. EndTimeTo specifies the end of the time range.

# Argument: 'xs:dateTime'

  getEndTimeTo()
  Calls: GetMyeBayBuying
  Returned: Conditionally
  Details: DetailLevel: none, ReturnSummary, ReturnAll

# Returns: 'xs:dateTime'

  setItemSort()
The ItemSort of a My eBay Favorite Search. Values for ItemSort include Best Match, EndTime, Distance, and other options listed in SimpleItemSortCodeType.

# Argument: 'ns:SimpleItemSortCodeType'

  getItemSort()
  Calls: GetMyeBayBuying
  Returned: Conditionally
  Details: DetailLevel: none, ReturnSummary, ReturnAll

# Returns: 'ns:SimpleItemSortCodeType'

  setItemType()
The ItemType of a My eBay Favorite Search. Setting ItemType in a search limits the results to items of a specific type, such as Fixed Price items, Store Inventory items, items with AdFormat, etc.

# Argument: 'ns:ItemTypeCodeType'

  getItemType()
  Calls: GetMyeBayBuying
  Returned: Conditionally
  Details: DetailLevel: none, ReturnSummary, ReturnAll

# Returns: 'ns:ItemTypeCodeType'

  setItemsAvailableTo()
The ItemsAvailableTo value in a My eBay Favorite Search. ItemsAvailableTo limits the result set to just those items available to the specified country.

# Argument: 'ns:CountryCodeType'

  getItemsAvailableTo()
  Calls: GetMyeBayBuying
  Returned: Conditionally
  Details: DetailLevel: none, ReturnSummary, ReturnAll

# Returns: 'ns:CountryCodeType'

  setItemsLocatedIn()
The ItemsLocatedIn value in a My eBay Favorite Search. ItemsLocatedIn limits the result set to just those items located in the specified country.

# Argument: 'ns:CountryCodeType'

  getItemsLocatedIn()
  Calls: GetMyeBayBuying
  Returned: Conditionally
  Details: DetailLevel: none, ReturnSummary, ReturnAll

# Returns: 'ns:CountryCodeType'

  setMaxDistance()
The MaxDistance of a My eBay Favorite Search. This is the maximum distance from the item-location value specified in PostalCode.

# Argument: 'xs:int'

  getMaxDistance()
  Calls: GetMyeBayBuying
  Returned: Conditionally
  Details: DetailLevel: none, ReturnSummary, ReturnAll

# Returns: 'xs:int'

  setPaymentMethod()
The PaymentMethod value in a My eBay Favorite Search. The PaymentMethod limits the search results to items that accept a specific payment method or methods.

# Argument: 'ns:PaymentMethodSearchCodeType'

  getPaymentMethod()
  Calls: GetMyeBayBuying
  Returned: Conditionally
  Details: DetailLevel: none, ReturnSummary, ReturnAll

# Returns: 'ns:PaymentMethodSearchCodeType'

  setPostalCode()
The PostalCode of a My eBay Favorite Search. This value indicates the postal code where an item is located.

# Argument: 'xs:string'

  getPostalCode()
  Calls: GetMyeBayBuying
  Returned: Conditionally
  Details: DetailLevel: none, ReturnSummary, ReturnAll

# Returns: 'xs:string'

  setPreferredLocation()
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.

# Argument: 'ns:PreferredLocationCodeType'

  getPreferredLocation()
  Calls: GetMyeBayBuying
  Returned: Conditionally
  Details: DetailLevel: none, ReturnSummary, ReturnAll

# Returns: 'ns:PreferredLocationCodeType'

  setPriceMax()
The PriceMax of a My eBay Favorite Search. PriceMax specifies the maximum current price an item can have to be included in the search results. PriceMax can be used with PriceMin to specify a range of prices.

# Argument: 'ns:AmountType'

  getPriceMax()
  Calls: GetMyeBayBuying
  Returned: Conditionally
  Details: DetailLevel: none, ReturnSummary, ReturnAll

# Returns: 'ns:AmountType'

  setPriceMin()
The PriceMin of a My eBay Favorite Search. PriceMin specifies the minimum current price an item listing can have to be included in the search results. PriceMin can be used with PriceMax to specify a range of prices.

# Argument: 'ns:AmountType'

  getPriceMin()
  Calls: GetMyeBayBuying
  Returned: Conditionally
  Details: DetailLevel: none, ReturnSummary, ReturnAll

# Returns: 'ns:AmountType'

  setQuantity()
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.

# Argument: 'xs:int'

  getQuantity()
  Calls: GetMyeBayBuying
  Returned: Conditionally
  Details: DetailLevel: none, ReturnSummary, ReturnAll

# Returns: 'xs:int'

  setQuantityOperator()
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.

# Argument: 'ns:QuantityOperatorCodeType'

  getQuantityOperator()
  Calls: GetMyeBayBuying
  Returned: Conditionally
  Details: DetailLevel: none, ReturnSummary, ReturnAll

# Returns: 'ns:QuantityOperatorCodeType'

  setQueryKeywords()
The QueryKeywords of a My eBay Favorite Search. A search that uses QueryKeywords is a query that specifies a string for searching titles of items on eBay.<br /><br /> If you are using a URL, then to search for multiple words, use "%20". For example, use Harry%20Potter to search for items containing those words in any order.<br /><br /> You can incorporate wildcards into a multi-word search, as in the following: ap*%20ip*.<br /><br /> The words "and" and "or" are treated like any other word. Only use "and", "or", or "the" if you are searching for listings containing these words.

# Argument: 'xs:string'

  getQueryKeywords()
  Calls: GetMyeBayBuying
  Returned: Conditionally
  Details: DetailLevel: none, ReturnSummary, ReturnAll

# Returns: 'xs:string'

  setSearchFlag()
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.

# Argument: reference to an array
                      of 'ns:SearchFlagCodeType'

  getSearchFlag()
  Calls: GetMyeBayBuying
  Returned: Conditionally
  AllValuesExcept: DigitalDelivery
  Details: DetailLevel: none, ReturnSummary, ReturnAll

# Returns: reference to an array
                      of 'ns:SearchFlagCodeType'

  setSearchName()
The name of a My eBay Favorite Search.

# Argument: 'xs:string'

  getSearchName()
  Calls: GetMyeBayBuying
  Returned: Conditionally
  Details: DetailLevel: none, ReturnSummary, ReturnAll

# Returns: 'xs:string'

  setSearchQuery()
The query string of a My eBay Favorite Search. You can paste this value, that is returned as a URL, into a browser to re-play the Favorite Search using the Trading Web Service.

# Argument: 'xs:string'

  getSearchQuery()
  Calls: GetMyeBayBuying
  Returned: Conditionally
  Details: DetailLevel: none, ReturnSummary, ReturnAll

# Returns: 'xs:string'

  setSellerBusinessType()
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.

# Argument: 'ns:SellerBusinessCodeType'

  getSellerBusinessType()
  Calls: GetMyeBayBuying
  Returned: Conditionally
  Details: DetailLevel: none, ReturnSummary, ReturnAll

# Returns: 'ns:SellerBusinessCodeType'

  setSellerID()
The SellerID value in a My eBay Favorite Search. The SellerID is the eBay ID of a specific seller.

# Argument: reference to an array
                      of 'xs:string'

  getSellerID()
  Calls: GetMyeBayBuying
  Returned: Conditionally
  Details: DetailLevel: none, ReturnSummary, ReturnAll

# Returns: reference to an array
                      of 'xs:string'

  setSellerIDExclude()
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.

# Argument: reference to an array
                      of 'xs:string'

  getSellerIDExclude()
  Calls: GetMyeBayBuying
  Returned: Conditionally
  Details: DetailLevel: none, ReturnSummary, ReturnAll

# Returns: reference to an array
                      of 'xs:string'

  setSortOrder()
The SortOrder of a My eBay Favorite Search. This value specifies whether you want to sort search results in ascending or descending order, in conjunction with the value you specify in ItemSort.

# Argument: 'ns:SortOrderCodeType'

  getSortOrder()
  Calls: GetMyeBayBuying
  Returned: Conditionally
  Details: DetailLevel: none, ReturnSummary, ReturnAll

# Returns: 'ns:SortOrderCodeType'