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

NAME

eBay::API::XML::DataType::ProductFamilyType

DESCRIPTION

A set of results returned from a catalog product search. Use GetProductSearchResults or GetProductFamilyMembers to perform the search. See the guide for information about Pre-filled Item Information (Catalogs) functionality.

SYNOPSIS

INHERITANCE

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

Subroutines:

setFamilyMembers()

A set of products (within the same product family) that match the search query.

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

getFamilyMembers()

Calls: GetProductFamilyMembers
       GetProductSearchResults
Returned: Always

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

setParentProduct()

A transient header that describes the current search results. Contains a an ID, a subset of attributes, and a typical stock photo to help a user easily distinguish the products in the current result set from products in other result sets returned in the same response. One ParentProduct is returned per ProductFamily.

# Argument: 'ns:ProductType'

getParentProduct()

Calls: GetProductFamilyMembers
       GetProductSearchResults
Returned: Always

# Returns: 'ns:ProductType'

setHasMoreChildren()

If true, the product family has more products than you requested in MaxChildrenPerFamily for a query in the GetProductSearchResults request. In this case, no products are returned in the GetProductSearchResults response. (Call GetProductFamilyMembers to retrieve all products in the family.) If false, the product family has MaxChildrenPerFamily or fewer product children, and the call returns all products in the family.

# Argument: 'xs:boolean'

isHasMoreChildren()

Calls: GetProductFamilyMembers
       GetProductSearchResults
Returned: Always

# Returns: 'xs:boolean'