complexType "ns:MyeBayFavoriteSearchType"

Overview

Namespace

WSDL

Schema

Component

Index

PREV C-TYPE NEXT C-TYPE

FRAMES NO FRAMES NS-Bindings

SUMMARY: XML REP | DERIVED | USE

DETAIL: DESC | XML SRC | TYPE | ATTR | CHILD

eBay Trading API

complexType "ns:MyeBayFavoriteSearchType"

Namespace:	urn:ebay:apis:eBLBaseComponents
Content:	complex, 27 elements, elem. wildcard
Defined:	globally in Schema in ebaySvc.wsdl; see XML source
Includes:	definitions of 27 elements, elem. wildcard
Used:	at 1 location

Component Diagram

XML Representation Summary

<...>

Content:

</...>

All Direct / Indirect Based Elements (1):

ns:FavoriteSearch

Known Usage Locations

As direct type of elements (1):

ns:FavoriteSearch

Annotation

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.

XML Source (w/o annotations (28); see within schema source)

<xs:complexType name="MyeBayFavoriteSearchType">

<xs:sequence>

<xs:element minOccurs="0" name="SearchName" type="xs:string"/>

<xs:element minOccurs="0" name="SearchQuery" type="xs:string"/>

<xs:element minOccurs="0" name="QueryKeywords" type="xs:string"/>

<xs:element minOccurs="0" name="CategoryID" type="xs:string"/>

<xs:element minOccurs="0" name="ItemSort" type="ns:SimpleItemSortCodeType"/>

<xs:element minOccurs="0" name="SortOrder" type="ns:SortOrderCodeType"/>

<xs:element minOccurs="0" name="EndTimeFrom" type="xs:dateTime"/>

<xs:element minOccurs="0" name="EndTimeTo" type="xs:dateTime"/>

<xs:element minOccurs="0" name="MaxDistance" type="xs:int"/>

<xs:element minOccurs="0" name="PostalCode" type="xs:string"/>

<xs:element minOccurs="0" name="ItemType" type="ns:ItemTypeCodeType"/>

<xs:element minOccurs="0" name="PriceMax" type="ns:AmountType"/>

<xs:element minOccurs="0" name="PriceMin" type="ns:AmountType"/>

<xs:element minOccurs="0" name="Currency" type="ns:CurrencyCodeType"/>

<xs:element minOccurs="0" name="BidCountMax" type="xs:int"/>

<xs:element minOccurs="0" name="BidCountMin" type="xs:int"/>

<xs:element maxOccurs="unbounded" minOccurs="0" name="SearchFlag" type="ns:SearchFlagCodeType"/>

<xs:element minOccurs="0" name="PaymentMethod" type="ns:PaymentMethodSearchCodeType"/>

<xs:element minOccurs="0" name="PreferredLocation" type="ns:PreferredLocationCodeType"/>

<xs:element maxOccurs="unbounded" minOccurs="0" name="SellerID" type="xs:string"/>

<xs:element maxOccurs="unbounded" minOccurs="0" name="SellerIDExclude" type="xs:string"/>

<xs:element minOccurs="0" name="ItemsAvailableTo" type="ns:CountryCodeType"/>

<xs:element minOccurs="0" name="ItemsLocatedIn" type="ns:CountryCodeType"/>

<xs:element minOccurs="0" name="SellerBusinessType" type="ns:SellerBusinessCodeType"/>

<xs:element minOccurs="0" name="Condition" type="ns:ItemConditionCodeType"/>

<xs:element minOccurs="0" name="Quantity" type="xs:int"/>

<xs:element minOccurs="0" name="QuantityOperator" type="ns:QuantityOperatorCodeType"/>

<xs:any maxOccurs="unbounded" minOccurs="0" processContents="lax"/>

</xs:sequence>

</xs:complexType>

Content Element Detail (all declarations defined in this component; 28/28)

ns:BidCountMax

Type:

xs:int, predefined, simple content

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

XML Representation Summary

<ns:BidCountMax>

Content:

{ xs:int }

</ns:BidCountMax>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="BidCountMax" type="xs:int"/>

ns:BidCountMin

Type:

xs:int, predefined, simple content

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.

XML Representation Summary

<ns:BidCountMin>

Content:

{ xs:int }

</ns:BidCountMin>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="BidCountMin" type="xs:int"/>

ns:CategoryID

Type:

xs:string, predefined, simple content

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.

XML Representation Summary

<ns:CategoryID>

Content:

{ xs:string }

</ns:CategoryID>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="CategoryID" type="xs:string"/>

ns:Condition

Type:

ns:ItemConditionCodeType, simple content

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.

XML Representation Summary

<ns:Condition>

Content:

{ enumeration of xs:token }

</ns:Condition>

Simple Content

Enumeration:

"New"	-	The seller specified the Item Condition as New, or did not specify a condition. (Excludes items that the seller listed as Used.)
"Used"	-	The seller specified the Item Condition as Used, or did not specify a condition. (Excludes items that the seller listed as New.)
"CustomCode"	-	(out) Reserved for internal or future use.

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="Condition" type="ns:ItemConditionCodeType"/>

ns:Currency

Type:

ns:CurrencyCodeType, simple content

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.

XML Representation Summary

<ns:Currency>

Content:

{ enumeration of xs:token }

</ns:Currency>

Simple Content

Enumeration:

see details at ns:CurrencyCodeType

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="Currency" type="ns:CurrencyCodeType"/>

ns:EndTimeFrom

Type:

xs:dateTime, predefined, simple content

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.

XML Representation Summary

<ns:EndTimeFrom>

Content:

{ xs:dateTime }

</ns:EndTimeFrom>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="EndTimeFrom" type="xs:dateTime"/>

ns:EndTimeTo

Type:

xs:dateTime, predefined, simple content

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.

XML Representation Summary

<ns:EndTimeTo>

Content:

{ xs:dateTime }

</ns:EndTimeTo>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="EndTimeTo" type="xs:dateTime"/>

ns:ItemsAvailableTo

Type:

ns:CountryCodeType, simple content

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

XML Representation Summary

<ns:ItemsAvailableTo>

Content:

{ enumeration of xs:token }

</ns:ItemsAvailableTo>

Simple Content

Enumeration:

see details at ns:CountryCodeType

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="ItemsAvailableTo" type="ns:CountryCodeType"/>

ns:ItemsLocatedIn

Type:

ns:CountryCodeType, simple content

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

XML Representation Summary

<ns:ItemsLocatedIn>

Content:

{ enumeration of xs:token }

</ns:ItemsLocatedIn>

Simple Content

Enumeration:

see details at ns:CountryCodeType

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="ItemsLocatedIn" type="ns:CountryCodeType"/>

ns:ItemSort

Type:

ns:SimpleItemSortCodeType, simple content

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.

XML Representation Summary

<ns:ItemSort>

Content:

{ enumeration of xs:token }

</ns:ItemSort>

Simple Content

Enumeration:

see details at ns:SimpleItemSortCodeType

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="ItemSort" type="ns:SimpleItemSortCodeType"/>

ns:ItemType

Type:

ns:ItemTypeCodeType, simple content

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.

XML Representation Summary

<ns:ItemType>

Content:

{ enumeration of xs:token }

</ns:ItemType>

Simple Content

Enumeration:

see details at ns:ItemTypeCodeType

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="ItemType" type="ns:ItemTypeCodeType"/>

ns:MaxDistance

Type:

xs:int, predefined, simple content

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.

XML Representation Summary

<ns:MaxDistance>

Content:

{ xs:int }

</ns:MaxDistance>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="MaxDistance" type="xs:int"/>

ns:PaymentMethod

Type:

ns:PaymentMethodSearchCodeType, simple content

This field is no longer applicable, as filtering by a payment method in an advanced item search is no longer supported/applicable.

XML Representation Summary

<ns:PaymentMethod>

Content:

{ enumeration of xs:token }

</ns:PaymentMethod>

Simple Content

Enumeration:

"PayPal"	-	This enumeration value indicates that the item may be purchased using PayPal as the payment method.
"PaisaPay"	-	PaisaPay is no longer a supported payment method, so this value is no longer applicable.
"PayPalOrPaisaPay"	-	PaisaPay is no longer a supported payment method, so this value is no longer applicable.
"CustomCode"	-	This enumeration value is reserved for future use.
"PaisaPayEscrowEMI"	-	PaisaPay is no longer a supported payment method, so this value is no longer applicable.

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="PaymentMethod" type="ns:PaymentMethodSearchCodeType"/>

ns:PostalCode

Type:

xs:string, predefined, simple content

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.

XML Representation Summary

<ns:PostalCode>

Content:

{ xs:string }

</ns:PostalCode>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="PostalCode" type="xs:string"/>

ns:PreferredLocation

Type:

ns:PreferredLocationCodeType, simple content

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.

XML Representation Summary

<ns:PreferredLocation>

Content:

{ enumeration of xs:token }

</ns:PreferredLocation>

Simple Content

Enumeration:

"ListedInCurrencyImplied"	-	(in) Items listed in the currency implied by the site specified in the request.
"LocatedInCountryImplied"	-	(in) Items located in the country implied by the site specified in the request.
"AvailableInCountryImplied"	-	(in) Items available to the country implied by the site specified in the request. For the US site, this implies listings from ALL English-language countries that are available to the US.
"SiteImplied"	-	(in) Items listed on the site specified in the request, regardless of listing currency.
"BelgiumListing"	-	(in) Items located in Belgium or listed on one of the two Belgian sites.
"CustomCode"	-	(out) Reserved for internal or future use.

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="PreferredLocation" type="ns:PreferredLocationCodeType"/>

ns:PriceMax

Type:

ns:AmountType, simple content

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.

Component Diagram

XML Representation Summary

<ns:PriceMax

currencyID

("AFA" | "ALL" | "DZD" | "ADP" | "AOA" | "ARS" | "AMD" | "AWG" | "AZM" | "BSD" | "BHD" | "BDT" | "BBD" | "BYR" | "BZD" | "BMD" | "BTN" | "INR" | "BOV" | "BOB" | "BAM" | "BWP" | "BRL" | "BND" | "BGL" | "BGN" | "BIF" | "KHR" | "CAD" | "CVE" | "KYD" | "XAF" | "CLF" | "CLP" | "CNY" | "COP" | "KMF" | "CDF" | "CRC" | "HRK" | "CUP" | "CYP" | "CZK" | "DKK" | "DJF" | "DOP" | "TPE" | "ECV" | "ECS" | "EGP" | "SVC" | "ERN" | "EEK" | "ETB" | "FKP" | "FJD" | "GMD" | "GEL" | "GHC" | "GIP" | "GTQ" | "GNF" | "GWP" | "GYD" | "HTG" | "HNL" | "HKD" | "HUF" | "ISK" | "IDR" | "IRR" | "IQD" | "ILS" | "JMD" | "JPY" | "JOD" | "KZT" | "KES" | "AUD" | "KPW" | "KRW" | "KWD" | "KGS" | "LAK" | "LVL" | "LBP" | "LSL" | "LRD" | "LYD" | "CHF" | "LTL" | "MOP" | "MKD" | "MGF" | "MWK" | "MYR" | "MVR" | "MTL" | "EUR" | "MRO" | "MUR" | "MXN" | "MXV" | "MDL" | "MNT" | "XCD" | "MZM" | "MMK" | "ZAR" | "NAD" | "NPR" | "ANG" | "XPF" | "NZD" | "NIO" | "NGN" | "NOK" | "OMR" | "PKR" | "PAB" | "PGK" | "PYG" | "PEN" | "PHP" | "PLN" | "USD" | "QAR" | "ROL" | "RUB" | "RUR" | "RWF" | "SHP" | "WST" | "STD" | "SAR" | "SCR" | "SLL" | "SGD" | "SKK" | "SIT" | "SBD" | "SOS" | "LKR" | "SDD" | "SRG" | "SZL" | "SEK" | "SYP" | "TWD" | "TJS" | "TZS" | "THB" | "XOF" | "TOP" | "TTD" | "TND" | "TRL" | "TMM" | "UGX" | "UAH" | "AED" | "GBP" | "USS" | "USN" | "UYU" | "UZS" | "VUV" | "VEB" | "VND" | "MAD" | "YER" | "YUM" | "ZMK" | "ZWD" | "ATS" | "CustomCode")

Content:

{ xs:double }

</ns:PriceMax>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="PriceMax" type="ns:AmountType"/>

ns:PriceMin

Type:

ns:AmountType, simple content

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.

Component Diagram

XML Representation Summary

<ns:PriceMin

currencyID

Content:

{ xs:double }

</ns:PriceMin>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="PriceMin" type="ns:AmountType"/>

ns:Quantity

Type:

xs:int, predefined, simple content

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.

XML Representation Summary

<ns:Quantity>

Content:

{ xs:int }

</ns:Quantity>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="Quantity" type="xs:int"/>

ns:QuantityOperator

Type:

ns:QuantityOperatorCodeType, simple content

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.

XML Representation Summary

<ns:QuantityOperator>

Content:

{ enumeration of xs:token }

</ns:QuantityOperator>

Simple Content

Enumeration:

"LessThan"	-	This enumeration value indicates that the quantity sought (specified in Quantity field) is less than the quantity available (specified in TotalAvailable field).
"LessThanOrEqual"	-	This enumeration value indicates that the quantity sought (specified in Quantity field) is less than or equal to the quantity available (specified in TotalAvailable field).
"Equal"	-	This enumeration value indicates that the quantity sought (specified in Quantity field) is equal to the quantity available (specified in TotalAvailable field).
"GreaterThan"	-	This enumeration value indicates that the quantity sought (specified in Quantity field) is greater than the quantity available (specified in TotalAvailable field).
"GreaterThanOrEqual"	-	This enumeration value indicates that the quantity sought (specified in Quantity field) is greater than or equal to the quantity available (specified in TotalAvailable field).
"CustomCode"	-	Reserved for internal or future use.

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="QuantityOperator" type="ns:QuantityOperatorCodeType"/>

ns:QueryKeywords

Type:

xs:string, predefined, simple content

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.

XML Representation Summary

<ns:QueryKeywords>

Content:

{ xs:string }

</ns:QueryKeywords>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="QueryKeywords" type="xs:string"/>

ns:SearchFlag

Type:

ns:SearchFlagCodeType, simple content

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.

XML Representation Summary

<ns:SearchFlag>

Content:

{ enumeration of xs:token }

</ns:SearchFlag>

Simple Content

Enumeration:

see details at ns:SearchFlagCodeType

XML Source (w/o annotations (1); see within schema source)

<xs:element maxOccurs="unbounded" minOccurs="0" name="SearchFlag" type="ns:SearchFlagCodeType"/>

ns:SearchName

Type:

xs:string, predefined, simple content

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.

XML Representation Summary

<ns:SearchName>

Content:

{ xs:string }

</ns:SearchName>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="SearchName" type="xs:string"/>

ns:SearchQuery

Type:

xs:string, predefined, simple content

This is the URL of the buyer's Saved Search on My eBay.

XML Representation Summary

<ns:SearchQuery>

Content:

{ xs:string }

</ns:SearchQuery>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="SearchQuery" type="xs:string"/>

ns:SellerBusinessType

Type:

ns:SellerBusinessCodeType, simple content

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.

XML Representation Summary

<ns:SellerBusinessType>

Content:

{ enumeration of xs:token }

</ns:SellerBusinessType>

Simple Content

Enumeration:

"Undefined"	-	Type of seller account not defined.
"Private"	-	Private seller account.
"Commercial"	-	Commercial seller account.
"CustomCode"	-	Reserved for internal or future use.

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="SellerBusinessType" type="ns:SellerBusinessCodeType"/>

ns:SellerID

Type:

xs:string, predefined, simple content

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

XML Representation Summary

<ns:SellerID>

Content:

{ xs:string }

</ns:SellerID>

XML Source (w/o annotations (1); see within schema source)

<xs:element maxOccurs="unbounded" minOccurs="0" name="SellerID" type="xs:string"/>

ns:SellerIDExclude

Type:

xs:string, predefined, simple content

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.

XML Representation Summary

<ns:SellerIDExclude>

Content:

{ xs:string }

</ns:SellerIDExclude>

XML Source (w/o annotations (1); see within schema source)

<xs:element maxOccurs="unbounded" minOccurs="0" name="SellerIDExclude" type="xs:string"/>

ns:SortOrder

Type:

ns:SortOrderCodeType, simple content

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.

XML Representation Summary

<ns:SortOrder>

Content:

{ enumeration of xs:token }

</ns:SortOrder>

Simple Content

Enumeration:

"Ascending"	-	The results will be sorted by the specified key in ascending (low to high) order.
"Descending"	-	The results will be sorted by the specified key in descending (high to low) order.
"CustomCode"	-	(out) Reserved for internal or future use.

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="SortOrder" type="ns:SortOrderCodeType"/>

{any element from any namespace}

XML Source (see within schema source)

<xs:any maxOccurs="unbounded" minOccurs="0" processContents="lax"/>

Overview

Namespace

WSDL

Schema

Component

Index

PREV C-TYPE NEXT C-TYPE

FRAMES NO FRAMES NS-Bindings

SUMMARY: XML REP | DERIVED | USE

DETAIL: DESC | XML SRC | TYPE | ATTR | CHILD

eBay Trading API

WSDL documentation generated with FlexDoc/XML 1.13 using FlexDoc/XML WSDLDoc 1.2.5 template set. All XSD diagrams generated by FlexDoc/XML DiagramKit.