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

NAME
eBay::API::XML::DataType::ProductSearchResultType

DESCRIPTION
Container for the results of a product query. Supports Pre-filled Product Information functionality. See the Developer's Guide for more information about working with this data.

SYNOPSIS

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

Subroutines:

  setAttributeSet()
A result containing a set of one or more product families. For GetProductSearchResults, if QueryKeywords and multiple characteristic set IDs were specified in the request, multiple AttributeSet objects can be returned. Each AttributeSet corresponds to a characteristic set ID specified in the request. See the eBay Web Services guide for more information about working with this data. For GetProductSearchResults, only returned with request version 387 and higher. For GetProductFamilyMembers, only returned with request version 415 and higher.

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

  getAttributeSet()
  Calls: GetProductFamilyMembers
         GetProductSearchResults
  Returned: Always

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

  setDisplayStockPhotos()
If true, your application should attempt to display stock photos that are returned. If false, your application should not attempt to display any stock photos that are returned. This recommendation is useful for catalog data related to products like coins, where stock photos are not applicable. An application with a graphical user interface can use this flag to determine when to hide stock photo widgets for a set of search results.

# Argument: 'xs:boolean'

  isDisplayStockPhotos()
  Calls: GetProductFamilyMembers
         GetProductSearchResults
  Returned: Always

# Returns: 'xs:boolean'

  setID()
Key you specified in ProductSearchID in the search request to distinguish between query results. Primarily useful when conducting multiple searches in the same call. If no ProductSearchID value was specified in the request, returns the array index of the search result (beginning with 0). Not applicable to GetProductFamilyMembers.

# Argument: 'xs:string'

  getID()
  Calls: GetProductSearchResults
  Returned: Always

# Returns: 'xs:string'

  setNumProducts()
Total quantity of products that match the search request (across all characteristic sets). This value can exceed the actual quantity of products returned in the current virtual page. Not applicable to GetProductFamilyMembers.

# Argument: 'xs:string'

  getNumProducts()
  Calls: GetProductSearchResults
  Returned: Always

# Returns: 'xs:string'