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

NAME
eBay::API::XML::DataType::SearchAttributesType

DESCRIPTION
A product or item aspect or feature that can be used as a criterion in a search for catalog content or for listed items. For example, "Format" might be a criterion for searching the catalogs for Pre-filled Item Information related to hardcover books.

SYNOPSIS

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

Subroutines:

  setAttributeID()
Unique identifier for the attribute within the characteristic set. Required if SearchAttributes is specified.

  Calls: GetSearchResults
  RequiredInput: Conditionally

  Calls: GetProductSearchResults
  RequiredInput: Yes

# Argument: 'xs:int'

  getAttributeID()
# Returns: 'xs:int'

  setDateSpecifier()
Specifies the date sub-component that the attribute represents. This only applies to date attributes. Required when searching by date attributes. Allows for separate text fields or drop-down lists to be rendered for each sub-component. For example, the day, month, and year can be rendered as separate drop-down lists.

Default:
  Calls: GetSearchResults
         GetProductSearchResults
  RequiredInput: Conditionally

# Argument: 'ns:DateSpecifierCodeType'

  getDateSpecifier()
# Returns: 'ns:DateSpecifierCodeType'

  setRangeSpecifier()
Indicates that the attribute represents the high or low end in a range, such as a date range or a price range. Required when searching on ranges.

Default:
  Calls: GetSearchResults
         GetProductSearchResults
  RequiredInput: Conditionally

# Argument: 'ns:RangeCodeType'

  getRangeSpecifier()
# Returns: 'ns:RangeCodeType'

  setValueList()
Container for the list of one or more valid values that the user has selected for the searchable attribute. If multiple values are specified, the search engine applies "OR" logic to the query (i.e., at least one of the specified values must match). Required if SearchAttributes is specified.

  Calls: GetSearchResults
         GetProductSearchResults
  RequiredInput: Conditionally

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

  getValueList()
# Returns: reference to an array
                      of 'ns:ValType'