NAME

eBay::API::XML::DataType::BiddingDetailsType

DESCRIPTION

Contains detailed information about a bid.

SYNOPSIS

INHERITANCE

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

Subroutines:

setBidAssistant()

Indicates whether the current bid was placed by BidAssistant. Only returns if true.

# Argument: 'xs:boolean'

isBidAssistant()

Calls: GetMyeBayBuying
Returned: Conditionally
Details: DetailLevel: none, ReturnSummary, ReturnAll
Context: BidList
         LostList
         WonList
         DeletedFromWonList
         DeletedFromLostList
         WatchList

Calls: GetMyeBaySelling
Returned: Conditionally
Details: DetailLevel: none, ReturnSummary, ReturnAll
Context: BidList

# Returns: 'xs:boolean'

setConvertedMaxBid()

Converted value of the amount in MaxBidAmount, in the currency indicated by SiteCurrency. For active items, refresh the listing's data every 24 hours to pick up the current conversion rates. Under conditions where this value would be N/A on the eBay site, this element is not returned at all.

# Argument: 'ns:AmountType'

getConvertedMaxBid()

Calls: GetMyeBayBuying
Returned: Conditionally
Details: DetailLevel: none, ReturnSummary, ReturnAll
Context: BidList
         LostList
         WonList
         DeletedFromWonList
         DeletedFromLostList

Calls: GetMyeBaySelling
Returned: Conditionally
Details: DetailLevel: none, ReturnSummary, ReturnAll
Context: BidList

# Returns: 'ns:AmountType'

setMaxBid()

Indicates the maximum amount the user has agreed to pay for the item when the user last submitted a bid. Under conditions where this value would be N/A on the eBay site, this element is not returned at all.

# Argument: 'ns:AmountType'

getMaxBid()

Calls: GetMyeBayBuying
Returned: Conditionally
Details: DetailLevel: none, ReturnSummary, ReturnAll
Context: BidList
         LostList
         WonList
         DeletedFromWonList
         DeletedFromLostList

Calls: GetMyeBaySelling
Returned: Conditionally
Details: DetailLevel: none, ReturnSummary, ReturnAll
Context: BidList

# Returns: 'ns:AmountType'

setQuantityBid()

Number of items from the listing the user agreed to purchase with a bid. For single-item listings, always 1. For multi-item listings, will be between 1 and the number of items offered in the auction. Number of items purchased so far.

# Argument: 'xs:int'

getQuantityBid()

Calls: GetMyeBayBuying
Returned: Conditionally
Details: DetailLevel: none, ReturnSummary, ReturnAll
Context: BidList
         LostList
         WonList
         DeletedFromWonList
         DeletedFromLostList

Calls: GetMyeBaySelling
Returned: Conditionally
Details: DetailLevel: none, ReturnSummary, ReturnAll
Context: BidList

# Returns: 'xs:int'

setQuantityWon()

Used mainly for Dutch auction. For an active listing, number of items the user stands to win if the user is a current winning bidder. For an ended listing, number of items the user actually won. In both cases, the number may be less than that returned in QuantityBid as the lowest winning bidder in a Dutch auction might not win the number of items the user has bid on.

# Argument: 'xs:int'

getQuantityWon()

Calls: GetMyeBayBuying
Returned: Conditionally
Details: DetailLevel: none, ReturnSummary, ReturnAll
Context: BidList
         LostList
         WonList
         DeletedFromWonList
         DeletedFromLostList

Calls: GetMyeBaySelling
Returned: Conditionally
Details: DetailLevel: none, ReturnSummary, ReturnAll
Context: BidList

# Returns: 'xs:int'

setWinning()

(GetMyeBay only) Indicates whether the user is the current high bidder in a currently active listing.

# Argument: 'xs:boolean'

isWinning()

# Returns: 'xs:boolean'