eBay::API::XML::Call::GetSearchResults::GetSearchResultsResponseType(3)

NAME
eBay::API::XML::Call::GetSearchResults::GetSearchResultsResponseType

DESCRIPTION
Response contains the item listings that have the specified keyword(s) in the title, sub-title, and (optionally) the description. If the request uses any of the optional filtering properties, the item listings returned are those containing the keyword(s) and meeting the filter criteria. <br><br> Not applicable to eBay Express or Half.com.

SYNOPSIS

INHERITANCE
eBay::API::XML::Call::GetSearchResults::GetSearchResultsResponseType inherits from the eBay::API::XML::ResponseDataType class

Subroutines:

  setAllCategoriesExpansionArray()
Can be returned if the request specifies that ExpandSearch is true. Provides additional search results when a small result set would have been returned with the original search. For example, on the US site (site ID 0), if a search would normally result in fewer than 10 items, and ExpandSearch is true, the search results are expanded to include (if matching the query) the AllCategoriesExpansionArray container for items, as well as other containers. The AllCategoriesExpansionArray container contains items available if category filters are removed.

# Argument: 'ns:ExpansionArrayType'

  getAllCategoriesExpansionArray()
  Returned: Conditionally
  Details: DetailLevel: ItemReturnCategories, ItemReturnAttributes, ReturnAll, none
#    Returns: 'ns:ExpansionArrayType'

  setBuyingGuideDetails()
Contains URLs and other information about relevant buying guides (if any), as well as the site's buying guide hub. Unavailable in the Sandbox environment. Buying guides are useful to buyers who do not have a specific product in mind. For example, a digital camera buying guide could help a buyer determine what kind of digital camera is right for them. Only returned for product finder searches (using SearchRequest.SearchAttributes) and for searches that retrieve matching categories along with item data (using Categories.CategoriesOnly=false).

# Argument: 'ns:BuyingGuideDetailsType'

  getBuyingGuideDetails()
  Returned: Conditionally
  Details: DetailLevel: ItemReturnCategories, ItemReturnAttributes, ReturnAll, none
#    Returns: 'ns:BuyingGuideDetailsType'

  setCategoryArray()
Shows the distribution of items across each category. Consists of statistical information about categories that contain items that match the query, if any. Returns empty if no matches are found or when the Categories filter was not passed in the request. (For categories associated with specific items, see items returned in each search result.) You must use fields within the Categories input container if you want the CategoryArray response container to be returned.

# Argument: 'ns:CategoryArrayType'

  getCategoryArray()
  Returned: Conditionally
  Details: DetailLevel: ItemReturnCategories, ItemReturnAttributes, ReturnAll, none
           GranularityLevel: Coarse

# Returns: 'ns:CategoryArrayType'

  setFilterRemovedExpansionArray()
Can be returned if the request specifies that ExpandSearch is true. Provides additional search results when a small result set would have been returned with the original search. For example, on the US site (site ID 0), if a search would normally result in fewer than 10 items, and ExpandSearch is true, the search results are expanded to include (if matching the query) the FilterRemovedExpansionArray container for items, as well as other containers. The FilterRemovedExpansionArray container contains items that would be returned if filters such as PriceRangeFilter are removed.

# Argument: 'ns:ExpansionArrayType'

  getFilterRemovedExpansionArray()
  Returned: Conditionally
  Details: DetailLevel: ItemReturnCategories, ItemReturnAttributes, ReturnAll, none
#    Returns: 'ns:ExpansionArrayType'

  setHasMoreItems()
Indicates whether there are more items, not yet returned, that match the search criteria.

# Argument: 'xs:boolean'

  isHasMoreItems()
  Returned: Always
  Details: DetailLevel: ItemReturnCategories, ItemReturnAttributes, ReturnAll, none
           GranularityLevel: Coarse

# Returns: 'xs:boolean'

  setInternationalExpansionArray()
Can be returned if the request specifies that ExpandSearch is true. Provides additional search results when a small result set would have been returned with the original search. For example, on the US site (site ID 0), if a search would normally result in fewer than 10 items, and ExpandSearch is true, the search results are expanded to include (if matching the query) the InternationalExpansionArray container for items, as well as other containers. The InternationalExpansionArray container contains items available from international sellers.

# Argument: 'ns:ExpansionArrayType'

  getInternationalExpansionArray()
  Returned: Conditionally
  Details: DetailLevel: ItemReturnCategories, ItemReturnAttributes, ReturnAll, none
#    Returns: 'ns:ExpansionArrayType'

  setItemsPerPage()
Indicates the maximum number of items that can be returned in a SearchResultItemArray for any given call.

# Argument: 'xs:int'

  getItemsPerPage()
  Returned: Always
  Details: DetailLevel: ItemReturnCategories, ItemReturnAttributes, ReturnAll, none
           GranularityLevel: Coarse

# Returns: 'xs:int'

  setPageNumber()
Indicates the page of data returned by the current call. For instance, for the first set of items can be returned, this field has a value of one.

# Argument: 'xs:int'

  getPageNumber()
  Returned: Always
  Details: DetailLevel: ItemReturnCategories, ItemReturnAttributes, ReturnAll, none
           GranularityLevel: Coarse

# Returns: 'xs:int'

  setPaginationResult()
Indicates the results of the pagination, including the total number of pages of data that can be returned and the total number of items that can be returned.

# Argument: 'ns:PaginationResultType'

  getPaginationResult()
  Returned: Always
  Details: DetailLevel: ItemReturnCategories, ItemReturnAttributes, ReturnAll, none
           GranularityLevel: Coarse

# Returns: 'ns:PaginationResultType'

  setRelatedSearchKeywordArray()
Container for keywords related to the original keywords in the request. Can be returned if the request specified more than zero in the MaxRelatedSearchKeywords field.

# Argument: 'ns:RelatedSearchKeywordArrayType'

  getRelatedSearchKeywordArray()
  Returned: Conditionally
  Details: DetailLevel: ItemReturnCategories, ItemReturnAttributes, ReturnAll, none
#    Returns: 'ns:RelatedSearchKeywordArrayType'

  setSearchResultItemArray()
Contains the returned item listings, if any. The data for each listing is returned in an ItemType object.

# Argument: 'ns:SearchResultItemArrayType'

  getSearchResultItemArray()
  Returned: Conditionally
  Details: DetailLevel: ItemReturnCategories, ItemReturnAttributes, ReturnAll, none
           GranularityLevel: Coarse

# Returns: 'ns:SearchResultItemArrayType'

  setSpellingSuggestion()
Suggestion for a different spelling of the search term or terms, along with the number of matching items that would have been returned if the suggestions had been used. The suggestions are given in Text tags and the suggestion for the first word is given before the suggestion for subsequent words. Suggestions are based on correctly-spelled terms in items, so suggestions vary over time and depend on whether a word or word combination is in one or more items.

# Argument: 'ns:SpellingSuggestionType'

  getSpellingSuggestion()
  Returned: Conditionally
  Details: DetailLevel: ItemReturnCategories, ItemReturnAttributes, ReturnAll, none
#    Returns: 'ns:SpellingSuggestionType'

  setStoreExpansionArray()
Contains items listed in the Store Inventory Format, if the request specifies that ExpandSearch is true.

# Argument: 'ns:ExpansionArrayType'

  getStoreExpansionArray()
  Returned: Conditionally
  Details: DetailLevel: ItemReturnCategories, ItemReturnAttributes, ReturnAll, none
#    Returns: 'ns:ExpansionArrayType'