eBay::API::XML::DataType::OfferType(3)

NAME
eBay::API::XML::DataType::OfferType

DESCRIPTION
Contains information pertaining to an offer made on an item listing and the current bidding or purchase state of the listing.

SYNOPSIS

INHERITANCE
eBay::API::XML::DataType::OfferType inherits from the eBay::API::XML::BaseDataType class

Subroutines:

  setAction()
Indicates the type of offer being made on the specified listing. If the item is best-offer enabled and the buyer makes a best offer (or counter-offer, etc.), then after the PlaceOffer call, the buyer can get the status of the best offer (and of a possible seller-counter-offer, etc.) using the GetBestOffers call. See the Trading Web Services Guide for information about best-offer enabled items and about GetBestOffers.

  Calls: PlaceOffer
  RequiredInput: Yes
  OnlyTheseValues: Bid, Purchase, Accept, Counter, Decline, Offer

# Argument: 'ns:BidActionCodeType'

  getAction()
  Calls: GetAllBidders
         GetHighBidders
  Returned: Always

# Returns: 'ns:BidActionCodeType'

  setBestOfferID()
The ID of a best offer on an item. Must be specified as input to PlaceOffer only if a buyer is accepting or declining a seller's counteroffer (and is not required for a buyer's offer or counteroffer).

  Calls: PlaceOffer
  RequiredInput: No

# Argument: 'ns:BestOfferIDType'

  getBestOfferID()
# Returns: 'ns:BestOfferIDType'

  setBidCount()
Total number of offers the user has made on the item.

# Argument: 'xs:int'

  getBidCount()
# Returns: 'xs:int'

  setConvertedPrice()
Localized amount for the item's current price.

# Argument: 'ns:AmountType'

  getConvertedPrice()
  Calls: GetAllBidders
         GetHighBidders
  Returned: Conditionally

# Returns: 'ns:AmountType'

  setCurrency()
Numeric ID for the currency for the auction. Valid values are enumerated in the CurrencyCodeType code list.

# Argument: 'ns:CurrencyCodeType'

  getCurrency()
  Calls: GetAllBidders
         GetHighBidders
  Returned: Always

# Returns: 'ns:CurrencyCodeType'

  setHighestBid()
Amount the highest bidder had bid on the item. Applicable only to competitive-bidding listings (Chinese and Dutch auctions) where there is progressive bidding and winning bidders are determined based on the highest bid.

# Argument: 'ns:AmountType'

  getHighestBid()
  Calls: GetAllBidders
  Returned: Always

# Returns: 'ns:AmountType'

  setItemID()
The unique identifier of an item listed on the eBay site. Returned by eBay when the item is created.

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

# Argument: 'ns:ItemIDType'

  getItemID()
# Returns: 'ns:ItemIDType'

  setMaxBid()
Amount of the offer placed. For competitive-bidding listings, the amount bid on the item (subject to outbid by other buyers). For fixed-price listings, the fixed sale price at which the item is purchased. For competitive-bidding listings with an active Buy It Now option, this amount will be either the Buy It Now price for purchase or the amount of a bid, depending on the offer type (as specified in Action). For PlaceOffer, the currencyID attribute is ignored if provided. Regarding Value-Added Tax (VAT): Even if VAT applies, you do not need to add VAT to the MaxBid value. If VAT applies to the listing, the seller can specify a VAT percent value when they list the item.

  Calls: PlaceOffer
  RequiredInput: Yes

# Argument: 'ns:AmountType'

  getMaxBid()
  Calls: GetAllBidders
         GetHighBidders
  Returned: Always

# Returns: 'ns:AmountType'

  setMessage()
A message from the buyer to the seller. Applies if the buyer is using PlaceOffer to perform a best-offer-related action (best offer, counter-offer, etc.).

  Calls: PlaceOffer
  RequiredInput: No

# Argument: 'xs:string'

  getMessage()
# Returns: 'xs:string'

  setQuantity()
Specifies the number of items from the specified listing the user tendering the offer intends to purchase, bid on, or make a best offer on. For Chinese auctions and other listing formats that only allow one item per listing, value may not exceed one. For multi-item listings, must be greater than zero and not exceeding the number of items offered for sale in the listing.

  Calls: PlaceOffer
  RequiredInput: Yes

# Argument: 'xs:int'

  getQuantity()
  Calls: GetAllBidders
         GetHighBidders
  Returned: Always

# Returns: 'xs:int'

  setSecondChanceEnabled()
Indicates the user's preference to accept second chance offers. If true, the user is willing to be the recipient of second chance offers.

# Argument: 'xs:boolean'

  isSecondChanceEnabled()
  Calls: GetAllBidders
  Returned: Always

# Returns: 'xs:boolean'

  setSiteCurrency()
Unique ID identifying the currency in which the localized offer amounts are expressed.

# Argument: 'ns:CurrencyCodeType'

  getSiteCurrency()
  Calls: GetAllBidders
         GetHighBidders
  Returned: Always

# Returns: 'ns:CurrencyCodeType'

  setTimeBid()
Date and time the offer or bid was placed.

# Argument: 'xs:dateTime'

  getTimeBid()
  Calls: GetAllBidders
         GetHighBidders
  Returned: Always

# Returns: 'xs:dateTime'

  setTransactionID()
The unique identifier of the transaction. The transaction is created when a winning bidder commits to purchasing an item, even before the bidder has paid.

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

# Argument: 'xs:string'

  getTransactionID()
# Returns: 'xs:string'

  setUser()
Bidder information. See the schema documentation for UserType for details on its properties and their meanings.

# Argument: 'ns:UserType'

  getUser()
  Calls: GetAllBidders
         GetHighBidders
  Returned: Always

# Returns: 'ns:UserType'

  setUserConsent()
If true, confirms that the bidder read and agrees to eBay's privacy policy. Applies if the subject item is in a category that requires user consent. If user consent (that is, confirmation that a bidder read and agrees to eBay's privacy policy) is required for a category that the subject item is in, this value must be true for a bid to occur.

  Calls: PlaceOffer
  RequiredInput: No

# Argument: 'xs:boolean'

  isUserConsent()
# Returns: 'xs:boolean'