Trading_OfferType Class Reference
| Inherits from | NSObject |
| Conforms to | PicoBindable |
| Declared in | Trading_OfferType.h Trading_OfferType.m |
Overview
Contains information pertaining to an offer made on an item listing and
the current bidding or purchase state of the listing.
@ingroup EBayAPIInterface
Tasks
-
actionIndicates the type of offer being made on the specified listing.
property
If the item is Best Offer enabled and the buyer
makes a Best Offer (or a counter offer), 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. -
currencyThree-digit currency code for the currency used for the auction. Valid values can
property
be viewed in the CurrencyCodeType code list. -
itemIDThe unique identifier of an item listed on the eBay site.
property
Returned by eBay when the item is created. -
maxBidAmount of the offer placed. For auction listings, the amount
property
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
auction 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. -
quantitySpecifies the number of items from the specified listing the user
property
tendering the offer intends to purchase, bid on, or make a Best Offer on.
For auctions, the 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. -
secondChanceEnabledIndicates the user’s preference to accept second chance offers. If true,
property
the user is willing to be the recipient of second chance offers. -
siteCurrencyUnique ID identifying the currency in which the localized offer amounts are
property
expressed. -
timeBidDate and time the offer or bid was placed.
property -
highestBidAmount the highest bidder has bid on the item. Applicable to only
property
auction listings where there is progressive bidding
and winning bidders are determined based on the highest bid. -
convertedPriceLocalized amount for the item’s current price.
property -
transactionIDThe unique identifier of the order line item (transaction). An order line item
property
is created when a winning bidder commits to purchasing an
item. -
userBidder information. See the schema documentation for UserType for details
property
on its properties and their meanings. -
userConsentIf true, confirms that the bidder read and agrees to eBay's
property
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. -
bidCountTotal number of offers the user has made on the item.
property -
messageA message from the buyer to the seller. Applies if the buyer
property
is using PlaceOffer to perform a best-offer-related
action (Best Offer, counter offer, etc.). -
bestOfferIDThe ID of a Best Offer on an item. Must be specified as input to PlaceOffer only if a
property
buyer is accepting or declining a seller’s counter offer (and is not required for a
buyer’s offer or counter offer). -
myMaxBidMaximum bid placed by the user making the call.
property -
any(public property)
property
Properties
action
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 a counter offer), 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.
@property (nonatomic, retain) NSString *actionDiscussion
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 a counter offer), 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.
type: string constant in Trading_BidActionCodeType.h
Declared In
Trading_OfferType.hany
(public property)
@property (nonatomic, retain) NSMutableArray *anyDiscussion
(public property)
entry type : PicoAnyElement, wrapper for primitive anyelement
Declared In
Trading_OfferType.hbestOfferID
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 counter offer (and is not required for a
buyer’s offer or counter offer).
@property (nonatomic, retain) NSString *bestOfferIDDiscussion
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 counter offer (and is not required for a
buyer’s offer or counter offer).
type : NSString, wrapper for primitive string
Declared In
Trading_OfferType.hbidCount
Total number of offers the user has made on the item.
@property (nonatomic, retain) NSNumber *bidCountDiscussion
Total number of offers the user has made on the item.
type : NSNumber, wrapper for primitive int
Declared In
Trading_OfferType.hconvertedPrice
Localized amount for the item’s current price.
@property (nonatomic, retain) Trading_AmountType *convertedPriceDeclared In
Trading_OfferType.hcurrency
Three-digit currency code for the currency used for the auction. Valid values can
be viewed in the CurrencyCodeType code list.
@property (nonatomic, retain) NSString *currencyDiscussion
Three-digit currency code for the currency used for the auction. Valid values can
be viewed in the CurrencyCodeType code list.
type: string constant in Trading_CurrencyCodeType.h
Declared In
Trading_OfferType.hhighestBid
Amount the highest bidder has bid on the item. Applicable to only
auction listings where there is progressive bidding
and winning bidders are determined based on the highest bid.
@property (nonatomic, retain) Trading_AmountType *highestBidDiscussion
Amount the highest bidder has bid on the item. Applicable to only
auction listings where there is progressive bidding
and winning bidders are determined based on the highest bid.
type : class Trading_AmountType
Declared In
Trading_OfferType.hitemID
The unique identifier of an item listed on the eBay site.
Returned by eBay when the item is created.
@property (nonatomic, retain) NSString *itemIDDiscussion
The unique identifier of an item listed on the eBay site.
Returned by eBay when the item is created.
type : NSString, wrapper for primitive string
Declared In
Trading_OfferType.hmaxBid
Amount of the offer placed. For auction 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
auction 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.
@property (nonatomic, retain) Trading_AmountType *maxBidDiscussion
Amount of the offer placed. For auction 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
auction 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.
type : class Trading_AmountType
Declared In
Trading_OfferType.hmessage
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.).
@property (nonatomic, retain) NSString *messageDiscussion
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.).
type : NSString, wrapper for primitive string
Declared In
Trading_OfferType.hmyMaxBid
Maximum bid placed by the user making the call.
@property (nonatomic, retain) Trading_AmountType *myMaxBidDeclared In
Trading_OfferType.hquantity
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 auctions, the 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.
@property (nonatomic, retain) NSNumber *quantityDiscussion
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 auctions, the 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.
type : NSNumber, wrapper for primitive int
Declared In
Trading_OfferType.hsecondChanceEnabled
Indicates the user’s preference to accept second chance offers. If true,
the user is willing to be the recipient of second chance offers.
@property (nonatomic, retain) NSNumber *secondChanceEnabledDiscussion
Indicates the user’s preference to accept second chance offers. If true,
the user is willing to be the recipient of second chance offers.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_OfferType.hsiteCurrency
Unique ID identifying the currency in which the localized offer amounts are
expressed.
@property (nonatomic, retain) NSString *siteCurrencyDiscussion
Unique ID identifying the currency in which the localized offer amounts are
expressed.
type: string constant in Trading_CurrencyCodeType.h
Declared In
Trading_OfferType.htimeBid
Date and time the offer or bid was placed.
@property (nonatomic, retain) NSDate *timeBidDiscussion
Date and time the offer or bid was placed.
type : NSDate, wrapper for primitive date
Declared In
Trading_OfferType.htransactionID
The unique identifier of the order line item (transaction). An order line item
is created when a winning bidder commits to purchasing an
item.
@property (nonatomic, retain) NSString *transactionIDDiscussion
The unique identifier of the order line item (transaction). An order line item
is created when a winning bidder commits to purchasing an
item.
type : NSString, wrapper for primitive string
Declared In
Trading_OfferType.huser
Bidder information. See the schema documentation for UserType for details
on its properties and their meanings.
@property (nonatomic, retain) Trading_UserType *userDiscussion
Bidder information. See the schema documentation for UserType for details
on its properties and their meanings.
type : class Trading_UserType
Declared In
Trading_OfferType.huserConsent
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.
@property (nonatomic, retain) NSNumber *userConsentDiscussion
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.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_OfferType.h