eBay::API::XML::DataType::BestOfferType - eBay::API::XML::DataType::BestOfferType documentation

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

Index

Code Index:

NAME

Top

eBay::API::XML::DataType::BestOfferType

DESCRIPTION

Top

Details about a best offer.

SYNOPSIS

Top

INHERITANCE

Top

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

Subroutines:

Top

setBestOfferCodeType()

The best offer type.

# Argument: 'ns:BestOfferTypeCodeType'

getBestOfferCodeType()

  Calls: GetBestOffers
  Returned: Always
  Details: DetailLevel: none, ReturnAll

# Returns: 'ns:BestOfferTypeCodeType'

setBestOfferID()

An ID to distinguish this best offer from other best offers made on the item.

# Argument: 'ns:BestOfferIDType'

getBestOfferID()

  Calls: GetBestOffers
  Returned: Always
  Details: DetailLevel: none, ReturnAll

  Calls: PlaceOffer
  Returned: Conditionally

# Returns: 'ns:BestOfferIDType'

setBuyer()

Information about the buyer who made the best offer.

# Argument: 'ns:UserType'

getBuyer()

  Calls: GetBestOffers
  Returned: Always
  Details: DetailLevel: none, ReturnAll

# Returns: 'ns:UserType'

setBuyerMessage()

Text message that was provided by a buyer when placing a best offer.

MaxLength: 500 (in bytes)

# Argument: 'xs:string'

getBuyerMessage()

  Calls: GetBestOffers
  Returned: Conditionally
  Details: DetailLevel: ReturnAll

# Returns: 'xs:string'

setCallStatus()

The status of the call, either Success or Failure.

# Argument: 'xs:string'

getCallStatus()

  Calls: RespondToBestOffer
  Returned: Always

# Returns: 'xs:string'

setExpirationTime()

Date and time (in GMT) the offer naturally expires (if the seller has not accepted or declined the offer).

# Argument: 'xs:dateTime'

getExpirationTime()

  Calls: GetBestOffers
  Returned: Always
  Details: DetailLevel: none, ReturnAll

# Returns: 'xs:dateTime'

setPrice()

The amount of the best offer.

# Argument: 'ns:AmountType'

getPrice()

  Calls: GetBestOffers
  Returned: Always
  Details: DetailLevel: none, ReturnAll

# Returns: 'ns:AmountType'

setQuantity()

The number of items for which the buyer is making an offer.

# Argument: 'xs:int'

getQuantity()

  Calls: GetBestOffers
  Returned: Always
  Details: DetailLevel: none, ReturnAll

# Returns: 'xs:int'

setSellerMessage()

Text response to buyer from seller.

MaxLength: 500 (in bytes)

# Argument: 'xs:string'

getSellerMessage()

  Calls: GetBestOffers
  Returned: Conditionally
  Details: DetailLevel: none, ReturnAll

# Returns: 'xs:string'

setStatus()

The state of the offer. In the case of a PlaceOffer response that specified a best offer, Status may be "Accepted" if the best offer was at or above an auto-accept price.

# Argument: 'ns:BestOfferStatusCodeType'

getStatus()

  Calls: GetBestOffers
  Returned: Always
  Details: DetailLevel: none, ReturnAll

  Calls: PlaceOffer
  Returned: Conditionally

# Returns: 'ns:BestOfferStatusCodeType'

eBay-API documentation Contained in the eBay-API distribution. 
#!/usr/bin/perl

package eBay::API::XML::DataType::BestOfferType;

use strict;
use warnings;  

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


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

use eBay::API::XML::DataType::AmountType;
use eBay::API::XML::DataType::BestOfferIDType;
use eBay::API::XML::DataType::UserType;
use eBay::API::XML::DataType::Enum::BestOfferStatusCodeType;
use eBay::API::XML::DataType::Enum::BestOfferTypeCodeType;


my @gaProperties = ( [ 'BestOfferCodeType', 'ns:BestOfferTypeCodeType', ''
	     ,'eBay::API::XML::DataType::Enum::BestOfferTypeCodeType', '' ]
	, [ 'BestOfferID', 'ns:BestOfferIDType', ''
	     ,'eBay::API::XML::DataType::BestOfferIDType', '1' ]
	, [ 'Buyer', 'ns:UserType', ''
	     ,'eBay::API::XML::DataType::UserType', '1' ]
	, [ 'BuyerMessage', 'xs:string', '', '', '' ]
	, [ 'CallStatus', 'xs:string', '', '', '' ]
	, [ 'ExpirationTime', 'xs:dateTime', '', '', '' ]
	, [ 'Price', 'ns:AmountType', ''
	     ,'eBay::API::XML::DataType::AmountType', '1' ]
	, [ 'Quantity', 'xs:int', '', '', '' ]
	, [ 'SellerMessage', 'xs:string', '', '', '' ]
	, [ 'Status', 'ns:BestOfferStatusCodeType', ''
	     ,'eBay::API::XML::DataType::Enum::BestOfferStatusCodeType', '' ]
                    );
push @gaProperties, @{eBay::API::XML::BaseDataType::getPropertiesList()};

my @gaAttributes = ( 
                    );
push @gaAttributes, @{eBay::API::XML::BaseDataType::getAttributesList()};


sub new {
  my $classname = shift;
  my %args = @_;
  my $self = $classname->SUPER::new(%args);
  return $self;
}

sub isScalar {
   return 0; 
}




sub setBestOfferCodeType {
  my $self = shift;
  $self->{'BestOfferCodeType'} = shift
}


sub getBestOfferCodeType {
  my $self = shift;
  return $self->{'BestOfferCodeType'};
}



sub setBestOfferID {
  my $self = shift;
  $self->{'BestOfferID'} = shift
}


sub getBestOfferID {
  my $self = shift;
  return $self->_getDataTypeInstance( 'BestOfferID'
		,'eBay::API::XML::DataType::BestOfferIDType');
}



sub setBuyer {
  my $self = shift;
  $self->{'Buyer'} = shift
}


sub getBuyer {
  my $self = shift;
  return $self->_getDataTypeInstance( 'Buyer'
		,'eBay::API::XML::DataType::UserType');
}



sub setBuyerMessage {
  my $self = shift;
  $self->{'BuyerMessage'} = shift
}


sub getBuyerMessage {
  my $self = shift;
  return $self->{'BuyerMessage'};
}



sub setCallStatus {
  my $self = shift;
  $self->{'CallStatus'} = shift
}


sub getCallStatus {
  my $self = shift;
  return $self->{'CallStatus'};
}



sub setExpirationTime {
  my $self = shift;
  $self->{'ExpirationTime'} = shift
}


sub getExpirationTime {
  my $self = shift;
  return $self->{'ExpirationTime'};
}



sub setPrice {
  my $self = shift;
  $self->{'Price'} = shift
}


sub getPrice {
  my $self = shift;
  return $self->_getDataTypeInstance( 'Price'
		,'eBay::API::XML::DataType::AmountType');
}



sub setQuantity {
  my $self = shift;
  $self->{'Quantity'} = shift
}


sub getQuantity {
  my $self = shift;
  return $self->{'Quantity'};
}



sub setSellerMessage {
  my $self = shift;
  $self->{'SellerMessage'} = shift
}


sub getSellerMessage {
  my $self = shift;
  return $self->{'SellerMessage'};
}



sub setStatus {
  my $self = shift;
  $self->{'Status'} = shift
}


sub getStatus {
  my $self = shift;
  return $self->{'Status'};
}





##  Attribute and Property lists
sub getPropertiesList {
   my $self = shift;
   return \@gaProperties;
}

sub getAttributesList {
   my $self = shift;
   return \@gaAttributes;
}



1;