/ 
eBay-API-0.25
River stage zero No dependents
/ eBay::API::XML::Call::GetBidderList

NAME

eBay::API::XML::Call::GetBidderList

DESCRIPTION

SYNOPSIS

INHERITANCE

eBay::API::XML::Call::GetBidderList inherits from the eBay::API::XML::BaseCall class

Subroutines:

setActiveItemsOnly()

Indicates whether to limit the result set to active items. If true, only active items are returned and the EndTimeFrom and EndTimeTo filters are ignored. If false (or not sent), active and ended items are returned.

RequiredInput: No
#    Argument: 'xs:boolean'

setEndTimeFrom()

Limits returned items to only those for which the item's end date is on or after the date-time specified. Specify an end date within 30 days prior to today. Items that ended more than 30 days ago are omitted from the results. If specified, EndTimeTo must also be specified. Express date-time in the format YYYY-MM-DD HH:MM:SS, and in GMT. (For information on how to convert between your local time zone and GMT, see Time Values Note.) This field is ignored if ActiveItemsOnly is true.

RequiredInput: Conditionally
#    Argument: 'xs:dateTime'

setEndTimeTo()

Limits returned items to only those for which the item's end date is on or before the date-time specified. If specified, EndTimeFrom must also be specified. Express date-time in the format YYYY-MM-DD HH:MM:SS, and in GMT. This field is ignored if ActiveItemsOnly is true.

RequiredInput: Conditionally
#    Argument: 'xs:dateTime'

setGranularityLevel()

For GetBidderList, you can reduce the ItemType fields and other fields returned by specifying one of two values in the GranularityLevel field, Coarse or Medium. If you specify Coarse, the primary fields returned are the following: Item.ItemID and Item.ListingDetails.EndTime. If you specify Medium, an abbreviated result set is returned that includes many more fields than in the case of Coarse, including the following: Item.BuyItNowPrice, Item.Currency, Item.Site, and Item.Title.

PresentDetails: Yes

RequiredInput: No
#    Argument: 'ns:GranularityLevelCodeType'

setUserID()

The user for whom information should be returned. If provided, overrides user defined via RequesterCredentials in header.

RequiredInput: No
#    Argument: 'ns:UserIDType'

getBidItemArray()

Array of items the bidder has bid on, has won or has lost.

Returned: Always
#    Returns: 'ns:ItemArrayType'

getBidder()

Data for one eBay bidder.

Returned: Always
#    Returns: 'ns:UserType'