/ 
eBay-API-0.25
River stage zero No dependents
/ eBay::API::XML::DataType::ProductSearchPageType

NAME

eBay::API::XML::DataType::ProductSearchPageType

DESCRIPTION

SYNOPSIS

INHERITANCE

eBay::API::XML::DataType::ProductSearchPageType inherits from the eBay::API::XML::BaseDataType class

Subroutines:

setDataElementSet()

Contains helpful hints for the user. Usage of this information is optional.

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

getDataElementSet()

Calls: GetProductSearchPage
Returned: Always
Details: DetailLevel: ReturnAll

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

setSearchCharacteristicsSet()

A list of attributes that describe the choice of search criteria for the specified characteristic set. The order in which the criteria are returned is not significant and may vary for different requests. See the eBay Web Services guide for details about how to use this data as input to GetProductSearchResults.

# Argument: 'ns:CharacteristicsSetType'

getSearchCharacteristicsSet()

Calls: GetProductSearchPage
Returned: Always
Details: DetailLevel: ReturnAll

# Returns: 'ns:CharacteristicsSetType'

setSearchType()

Ignore this field. GetProductSearchPage only retrieves criteria for single-attribute searches. Use GetProductFinder for valid multi-attribute search criteria.

# Argument: 'ns:CharacteristicsSearchCodeType'

getSearchType()

Calls: GetProductSearchPage
Returned: Always
Details: DetailLevel: ReturnAll

# Returns: 'ns:CharacteristicsSearchCodeType'

setSortCharacteristics()

A product aspect or feature that can be used as a key for sorting catalog search results. This does not necessarily match a searchable attribute. For example, you might be able to search on a product's title but sort the results by the release date or the manufacturer's suggested retail price (MSRP). At least one sort attribute is always returned. Applications should ensure that only one attribute is selected as a sort key from these results (before calling GetProductSearchResults). The default sort key is the one with the lowest DisplaySequence value. The order in which the SortCharacteristics nodes are returned is not significant and may vary for different requests. See the eBay Web Services guide for details about how to use this data as input to GetProductSearchResults.

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

getSortCharacteristics()

Calls: GetProductSearchPage
Returned: Always
Details: DetailLevel: ReturnAll

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