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
-
action
Indicates 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. -
currency
Three-digit currency code for the currency used for the auction. Valid values can
property
be viewed in the CurrencyCodeType code list. -
itemID
The unique identifier of an item listed on the eBay site.
property
Returned by eBay when the item is created. -
maxBid
Amount 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. -
quantity
Specifies 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. -
secondChanceEnabled
Indicates the user’s preference to accept second chance offers. If true,
property
the user is willing to be the recipient of second chance offers. -
siteCurrency
Unique ID identifying the currency in which the localized offer amounts are
property
expressed. -
timeBid
Date and time the offer or bid was placed.
property -
highestBid
Amount 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. -
convertedPrice
Localized amount for the item’s current price.
property -
transactionID
The unique identifier of the order line item (transaction). An order line item
property
is created when a winning bidder commits to purchasing an
item. -
user
Bidder information. See the schema documentation for UserType for details
property
on its properties and their meanings. -
userConsent
If 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. -
bidCount
Total number of offers the user has made on the item.
property -
message
A 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.). -
bestOfferID
The 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). -
myMaxBid
Maximum 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 *action
Discussion
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.h
any
(public property)
@property (nonatomic, retain) NSMutableArray *any
Discussion
(public property)
entry type : PicoAnyElement, wrapper for primitive anyelement
Declared In
Trading_OfferType.h
bestOfferID
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 *bestOfferID
Discussion
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.h
bidCount
Total number of offers the user has made on the item.
@property (nonatomic, retain) NSNumber *bidCount
Discussion
Total number of offers the user has made on the item.
type : NSNumber, wrapper for primitive int
Declared In
Trading_OfferType.h
convertedPrice
Localized amount for the item’s current price.
@property (nonatomic, retain) Trading_AmountType *convertedPrice
Declared In
Trading_OfferType.h
currency
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 *currency
Discussion
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.h
highestBid
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 *highestBid
Discussion
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.h
itemID
The unique identifier of an item listed on the eBay site.
Returned by eBay when the item is created.
@property (nonatomic, retain) NSString *itemID
Discussion
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.h
maxBid
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 *maxBid
Discussion
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.h
message
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 *message
Discussion
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.h
myMaxBid
Maximum bid placed by the user making the call.
@property (nonatomic, retain) Trading_AmountType *myMaxBid
Declared In
Trading_OfferType.h
quantity
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 *quantity
Discussion
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.h
secondChanceEnabled
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 *secondChanceEnabled
Discussion
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.h
siteCurrency
Unique ID identifying the currency in which the localized offer amounts are
expressed.
@property (nonatomic, retain) NSString *siteCurrency
Discussion
Unique ID identifying the currency in which the localized offer amounts are
expressed.
type: string constant in Trading_CurrencyCodeType.h
Declared In
Trading_OfferType.h
timeBid
Date and time the offer or bid was placed.
@property (nonatomic, retain) NSDate *timeBid
Discussion
Date and time the offer or bid was placed.
type : NSDate, wrapper for primitive date
Declared In
Trading_OfferType.h
transactionID
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 *transactionID
Discussion
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.h
user
Bidder information. See the schema documentation for UserType for details
on its properties and their meanings.
@property (nonatomic, retain) Trading_UserType *user
Discussion
Bidder information. See the schema documentation for UserType for details
on its properties and their meanings.
type : class Trading_UserType
Declared In
Trading_OfferType.h
userConsent
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 *userConsent
Discussion
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