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

eBay-API documentation Contained in the eBay-API distribution.

Index

Code Index:

NAME

Top

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

DESCRIPTION

Top

SYNOPSIS

Top

INHERITANCE

Top

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

Subroutines:

Top

setCallMode()

Specifies which bidder information to return.

  RequiredInput: Yes
#    Argument: 'ns:GetAllBiddersModeCodeType'

setIncludeBiddingSummary()

Specifies whether return BiddingSummary container for each offer.

  RequiredInput: Conditionally
#    Argument: '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'

getBidArray()

Contains a list of OfferType objects. Each OfferType object represents the data for one bidder and bid.

  Returned: Always
#    Returns: 'ns:OfferArrayType'

getHighBidder()

eBay user ID for the user with the highest bid (or the earliest timestamp, in the event of a tie); a second chance offer candidate.

  Returned: Always
#    Returns: 'ns:UserIDType'

getHighestBid()

Bid amount offered by the HighBidder.

  Returned: Always
#    Returns: 'ns:AmountType'

getListingStatus()

Specifies an active or ended listing's status in eBay's processing workflow. If a listing ends with a sale (or sales), eBay needs to update the sale details (e.g., winning bidder) and other information. This processing can take several minutes. If you retrieve a sold item, use this listing status information to determine whether eBay has finished processing the listing so that you can be sure the winning bidder and other details are correct and complete.

  Returned: Always
#    Returns: 'ns:ListingStatusCodeType'
eBay-API documentation Contained in the eBay-API distribution. 
#!/usr/bin/perl

package eBay::API::XML::Call::GetAllBidders;

use strict;
use warnings;  

##########################################################################
#
# Module: ............... <user defined location>eBay/API/XML
# File: ................. GetAllBidders.pm
# Generated by: ......... genEBayApiDataTypes.pl
# Last Generated: ....... 08/24/2008 16:44
# API Release Number: ... 579
#
##########################################################################  


use eBay::API::XML::BaseCall;
our @ISA = ("eBay::API::XML::BaseCall");

use eBay::API::XML::Call::GetAllBidders::GetAllBiddersRequestType;
use eBay::API::XML::Call::GetAllBidders::GetAllBiddersResponseType;



sub getApiCallName {
   return 'GetAllBidders';
}
sub getRequestDataTypeFullPackage {
   return 'eBay::API::XML::Call::GetAllBidders::GetAllBiddersRequestType';
}
sub getResponseDataTypeFullPackage {
   return 'eBay::API::XML::Call::GetAllBidders::GetAllBiddersResponseType';
}

#
# input properties
#


       
sub setCallMode {
   my $self   = shift;
   my $sCallMode = shift;
   $self->getRequestDataType()->setCallMode($sCallMode);
}


       
sub setIncludeBiddingSummary {
   my $self   = shift;
   my $sIncludeBiddingSummary = shift;
   $self->getRequestDataType()->setIncludeBiddingSummary($sIncludeBiddingSummary);
}


       
sub setItemID {
   my $self   = shift;
   my $pItemID = shift;
   $self->getRequestDataType()->setItemID($pItemID);
}



#
# output properties
#


       
sub getBidArray {
   my $self = shift;
   return $self->getResponseDataType()->getBidArray();
}


       
sub getHighBidder {
   my $self = shift;
   return $self->getResponseDataType()->getHighBidder();
}


       
sub getHighestBid {
   my $self = shift;
   return $self->getResponseDataType()->getHighestBid();
}


       
sub getListingStatus {
   my $self = shift;
   return $self->getResponseDataType()->getListingStatus();
}





1;