eBay::API::XML::Call::GetAllBidders::GetAllBiddersRequestType - eBay::API::XML::Call::GetAllBidders::GetAllBiddersRequestType documentation


eBay-API documentation  | view source Contained in the eBay-API distribution.

Index


NAME

Top

eBay::API::XML::Call::GetAllBidders::GetAllBiddersRequestType

DESCRIPTION

Top

Provides three modes for retrieving a list of the users that bid on a listing. One of the modes is of particular value in support of the Second Chance Offer feature. Includes the list of bidders for the requested item as part of the general item listing data.

SYNOPSIS

Top

INHERITANCE

Top

eBay::API::XML::Call::GetAllBidders::GetAllBiddersRequestType inherits from the eBay::API::XML::RequestDataType class

Subroutines:

Top

setCallMode()

Specifies which bidder information to return.

  RequiredInput: Yes
#    Argument: 'ns:GetAllBiddersModeCodeType'

getCallMode()

# Returns: 'ns:GetAllBiddersModeCodeType'

setIncludeBiddingSummary()

Specifies whether return BiddingSummary container for each offer.

  RequiredInput: Conditionally
#    Argument: 'xs:boolean'

isIncludeBiddingSummary()

# Returns: 'xs:boolean'

setItemID()

The item ID for which to retrieve the list of bidders.

MaxLength: 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits)

  RequiredInput: Yes
#    Argument: 'ns:ItemIDType'

getItemID()

# Returns: 'ns:ItemIDType'


eBay-API documentation  | view source Contained in the eBay-API distribution.