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

NAME
eBay::API::XML::DataType::ProductType

DESCRIPTION
A prototype description of a well-known type of item, such as a popular book. Applicable when working with eBay's Pre-filled Item Information feature.

SYNOPSIS

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

Subroutines:

  setCharacteristicsSet()
A set of characteristics that describe the product in a standardized way. In responses, only the attributes and values that applicable for the specified product are returned.

  Calls: GetProductSellingPages
  RequiredInput: Yes

# Argument: 'ns:CharacteristicsSetType'

  getCharacteristicsSet()
  Calls: GetProductFamilyMembers
         GetProductSearchResults
  Returned: Always

# Returns: 'ns:CharacteristicsSetType'

  setDetailsURL()
Fully qualified URL for optional information about the product, such as a movie's description or film credits. This information is hosted through the eBay site and cannot be edited. Applications can include this URL as a link in product search results so that end users can view additional descriptive details about the product.

# Argument: 'xs:anyURI'

  getDetailsURL()
  Calls: GetProductFamilyMembers
  Returned: Always
  Context: FamilyMembers

  Calls: GetProductSearchResults
  Returned: Always

# Returns: 'xs:anyURI'

  setMaxPrice()
Highest current price of active and ended listings on the specified eBay site that were pre-filled based on this product. The value is in the specified site's currency. Round numbers (such as 15.0) may only show one zero after the decimal (as with any double in the schema).

# Argument: 'ns:AmountType'

  getMaxPrice()
  Calls: GetProductSearchResults
  Returned: Always
  Max:
  Min: 0.0
  Context: FamilyMembers

# Returns: 'ns:AmountType'

  setMinPrice()
Lowest current price of active and ended listings on the specified eBay site that were pre-filled based on this product. The value is in the specified site's currency.

# Argument: 'ns:AmountType'

  getMinPrice()
  Calls: GetProductSearchResults
  Returned: Always
  Max:
  Min: 0.0
  Context: FamilyMembers

# Returns: 'ns:AmountType'

  setNumItems()
Total number of active listings on the specified eBay site that were pre-filled based on this product.

# Argument: 'xs:int'

  getNumItems()
  Calls: GetProductSearchResults
  Returned: Always
  Max:
  Min: 0
  Context: FamilyMembers

# Returns: 'xs:int'

  setProductID()
For GetProductFamilyMembers, GetProductSearchResults, and GetProductSellingPages, a unique identifier for the product. The ID is defined in an eBay catalog. Product IDs may change over time. Therefore, use the catalog search calls (GetProductSearchResults and GetProductFamilyMembers) to update any product IDs that you store locally.

MaxLength: 4000

  Calls: GetProductSellingPages
  RequiredInput: Yes

# Argument: 'xs:string'

  getProductID()
  Calls: GetProductFamilyMembers
         GetProductSearchResults
  Returned: Always

# Returns: 'xs:string'

  setStockPhotoURL()
Fully qualified URL for a standard image that is associated with the product, if available. Allows the user to preview the image from your application. A user can choose to include the stock photo in a listing.

# Argument: 'xs:anyURI'

  getStockPhotoURL()
  Calls: GetProductFamilyMembers
         GetProductSearchResults
         GetProductSearchPage
  Returned: Conditionally

# Returns: 'xs:anyURI'

  setTitle()
The name of the product, as defined within the catalog. Not necessarily the same as the "Title" attribute in the characteristics set meta-data, if any. On the eBay site, this title serves as the basis for the suggested item title (truncated to the max length permitted for Title in item-listing calls). Applications can use this value to supply a suggested listing title to users.

# Argument: 'xs:string'

  getTitle()
  Calls: GetProductFamilyMembers
  Returned: Always
  Context: FamilyMembers

  Calls: GetProductSearchResults
  Returned: Always

# Returns: 'xs:string'