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

NAME
eBay::API::XML::DataType::CharacteristicType

DESCRIPTION
A salient aspect or feature of an item. Used to describe an item in a standard way so that buyers can find it more easily. An individual, standardized characteristic that is common to all items within the specified characteristics set. Applicable when working with Item Specifics (Attributes) and Pre-filled Item Information (Catalogs) functionality. See the eBay Web Services guide for more information.

SYNOPSIS

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

Subroutines:

  setAttributeID()
Constant value that identifies the characteristic in a language-independent way. Unique within the characteristic set.

# Argument: 'xs:int'

  getAttributeID()
  Calls: GetProductFamilyMembers
         GetProductSearchPage
         GetProductSearchResults
  Returned: Always
  Details: DetailLevel: ReturnAll

# Returns: 'xs:int'

  setDateFormat()
Applicable when working with Pre-filled Item Information (Catalogs) functionality. Returned if the characteristic is a Date data type. Specifies the pattern to use when presenting the date to a user. Possible values: Day/Month/Year, Month/Year, Year Only. For example, the Year Only format would indicate that the date should be a value like 1999. Output only.

# Argument: 'xs:string'

  getDateFormat()
  Calls: GetProductSearchPage
  Returned: Conditionally
  Details: DetailLevel: ReturnAll
  Context: SortCharacteristics

  Calls: GetProductFamilyMembers
         GetProductSearchResults
  Returned: Conditionally

# Returns: 'xs:string'

  setDisplaySequence()
The suggested order in which the characteristic should be presented to the user in a list. Indicates the relative position of the sort key in the list of characteristics. The characteristic with the lowest display sequence is considered the default sort key in calls to GetProductSearchResults. Aside from that, usage of this display sequence information is optional. For example, in an application with a graphical user interface, a characteristic with a display sequence of 2 could be presented before one with a display sequence of 3 in a drop-down list. If multiple sort characteristics are returned for a characteristic set, compare their display sequence values to determine the lowest available value (usually 0) and the overall sequence.

# Argument: 'xs:string'

  getDisplaySequence()
  Calls: GetProductFamilyMembers
         GetProductSearchPage
         GetProductSearchResults
  Returned: Always
  Details: DetailLevel: ReturnAll

# Returns: 'xs:string'

  setDisplayUOM()
Applicable when working with Pre-filled Item Information (Catalogs) functionality. The unit of measure (e.g., Inch) to use when the characteristic is numeric indicates a measurement. Not returned if not applicable. Output only.

# Argument: 'xs:string'

  getDisplayUOM()
  Calls: GetProductSearchPage
  Returned: Conditionally
  Details: DetailLevel: ReturnAll
  Context: SortCharacteristics

  Calls: GetProductFamilyMembers
         GetProductSearchResults
  Returned: Conditionally

# Returns: 'xs:string'

  setLabel()
Applicable when working with Pre-filled Item Information (Catalogs) functionality. The label to display when presenting the attribute to a user. Not necessarily the same as the attribute's label as defined in the characteristic set (i.e., the label could be overridden by the catalog).

# Argument: 'ns:LabelType'

  getLabel()
  Calls: GetProductFamilyMembers
         GetProductSearchPage
         GetProductSearchResults
  Returned: Always
  Details: DetailLevel: ReturnAll

# Returns: 'ns:LabelType'

  setSortOrder()
Applicable when working with Pre-filled Item Information (Catalogs) functionality. Indicates the order in which eBay's search engine will sort the results if you pass this characteristic as a sort attribute in GetProductSearchResults. You cannot change the sort order of a characteristic when you perform a search. (Of course, you can change the sort order when you present results in your own application.) In GetProductSearchPage, if SortOrder is not returned at all, it means the results will be returned in the order in which they are stored on eBay (which can be useful for international sites that use ideographic characters). Output only.

# Argument: 'ns:SortOrderCodeType'

  getSortOrder()
  Calls: GetProductSearchPage
  Returned: Conditionally
  Details: DetailLevel: ReturnAll
  Context: SortCharacteristics

# Returns: 'ns:SortOrderCodeType'

  setValueList()
List of one or more valid values for the characteristic.

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

  getValueList()
  Calls: GetProductFamilyMembers
         GetProductSearchResults
  Returned: Always

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