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

NAME
eBay::API::XML::DataType::ExpansionArrayType

DESCRIPTION
Container for items returned with an expanded search.

SYNOPSIS

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

Subroutines:

  setExpansionItem()
Item that is the result of an expanded search. If, in a GetSearchResults request, you specify true for ExpandSearch, the search is expanded when a small result set is returned. For example, on the US site (site ID 0), if a search would normally result in fewer than 10 items, then the search results are expanded. Specifically, the search returns items (if there are matches) in one or more of the following containers: InternationalExpansionArray (for items available from international sellers), FilterRemovedExpansionArray (items that would be returned if filters such as PriceRangeFilter are removed), StoreExpansionArray (for items listed in the Store Inventory Format), and AllCategoriesExpansionArray (for items available if category filters are removed). The maximum number of items returned in each container is 6 to 10.

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

  getExpansionItem()
  Calls: GetSearchResults
  Returned: Conditionally
  Details: DetailLevel: ItemReturnAttributes, ItemReturnCategories, none, ReturnAll

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

  setTotalAvailable()
The number of matching items available under the expansion.

# Argument: 'xs:int'

  getTotalAvailable()
  Calls: GetSearchResults
  Returned: Conditionally
  Details: DetailLevel: ItemReturnAttributes, ItemReturnCategories, none, ReturnAll

# Returns: 'xs:int'