Trading_PlaceOfferRequestType Class Reference
Inherits from | Trading_AbstractRequestType : NSObject |
Declared in | Trading_PlaceOfferRequestType.h Trading_PlaceOfferRequestType.m |
Overview
Enables the authenticated user to to make a bid, a best offer, or
a purchase on the item specified by the ItemID input field.
@ingroup EBayAPIInterface
Tasks
-
offer
Specifies the type of offer being made. If the item is a
property
competitive-bidding listing, the offer is a bid. If the item is a
fixed-price listing, then the offer purchases the item. If the item is a
competitive-bidding listing and the offer is of type with an active,
unexercised Buy It Now option, then the offer can either purchase the
item or be a bid. See the schema documentation for OfferType for details
on its properties and their meanings. -
itemID
Unique item ID that identifies the item listing for which the action is being
property
submitted.
If the item was listed with Variations, you must also specify
VariationSpecifics in the request to uniquely identify the
variant being purchased. -
blockOnWarning
If a warning message exists and BlockOnWarning is true,
property
the warning message is returned and the bid is blocked. If no warning message
exists and BlockOnWarning is true, the bid is placed. If BlockOnWarning
is false, the bid is placed, regardless of warning. -
affiliateTrackingDetails
Container for affiliate-related tags, which enable the tracking of user
property
activity. If you include AffiliateTrackingDetails in your PlaceOffer call, then
it is possible to receive affiliate commissions based on calls made by your
application. (See the eBay Partner Network
for information about commissions.) Please note that affiliate tracking is not
available in the Sandbox environment, and that affiliate tracking is not
available when you make a best offer. -
variationSpecifics
Name-value pairs that identify a single variation within the
property
listing identified by ItemID. Required when the seller
listed the item with Item Variations.
If you want to buy items from multiple variations in the same
listing, use a separate PlaceOffer request for each variation.
For example, if you want to buy 3 red shirts and 2 black shirts
from the same listing, use one PlaceOffer request for the
3 red shirts, and another PlaceOffer request for the 2
black shirts.
Properties
affiliateTrackingDetails
Container for affiliate-related tags, which enable the tracking of user
activity. If you include AffiliateTrackingDetails in your PlaceOffer call, then
it is possible to receive affiliate commissions based on calls made by your
application. (See the eBay Partner Network
for information about commissions.) Please note that affiliate tracking is not
available in the Sandbox environment, and that affiliate tracking is not
available when you make a best offer.
@property (nonatomic, retain) Trading_AffiliateTrackingDetailsType *affiliateTrackingDetails
Discussion
Container for affiliate-related tags, which enable the tracking of user
activity. If you include AffiliateTrackingDetails in your PlaceOffer call, then
it is possible to receive affiliate commissions based on calls made by your
application. (See the eBay Partner Network
for information about commissions.) Please note that affiliate tracking is not
available in the Sandbox environment, and that affiliate tracking is not
available when you make a best offer.
type : class Trading_AffiliateTrackingDetailsType
Declared In
Trading_PlaceOfferRequestType.h
blockOnWarning
If a warning message exists and BlockOnWarning is true,
the warning message is returned and the bid is blocked. If no warning message
exists and BlockOnWarning is true, the bid is placed. If BlockOnWarning
is false, the bid is placed, regardless of warning.
@property (nonatomic, retain) NSNumber *blockOnWarning
Discussion
If a warning message exists and BlockOnWarning is true,
the warning message is returned and the bid is blocked. If no warning message
exists and BlockOnWarning is true, the bid is placed. If BlockOnWarning
is false, the bid is placed, regardless of warning.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_PlaceOfferRequestType.h
itemID
Unique item ID that identifies the item listing for which the action is being
submitted.
If the item was listed with Variations, you must also specify
VariationSpecifics in the request to uniquely identify the
variant being purchased.
@property (nonatomic, retain) NSString *itemID
Discussion
Unique item ID that identifies the item listing for which the action is being
submitted.
If the item was listed with Variations, you must also specify
VariationSpecifics in the request to uniquely identify the
variant being purchased.
type : NSString, wrapper for primitive string
Declared In
Trading_PlaceOfferRequestType.h
offer
Specifies the type of offer being made. If the item is a
competitive-bidding listing, the offer is a bid. If the item is a
fixed-price listing, then the offer purchases the item. If the item is a
competitive-bidding listing and the offer is of type with an active,
unexercised Buy It Now option, then the offer can either purchase the
item or be a bid. See the schema documentation for OfferType for details
on its properties and their meanings.
@property (nonatomic, retain) Trading_OfferType *offer
Discussion
Specifies the type of offer being made. If the item is a
competitive-bidding listing, the offer is a bid. If the item is a
fixed-price listing, then the offer purchases the item. If the item is a
competitive-bidding listing and the offer is of type with an active,
unexercised Buy It Now option, then the offer can either purchase the
item or be a bid. See the schema documentation for OfferType for details
on its properties and their meanings.
type : class Trading_OfferType
Declared In
Trading_PlaceOfferRequestType.h
variationSpecifics
Name-value pairs that identify a single variation within the
listing identified by ItemID. Required when the seller
listed the item with Item Variations.
If you want to buy items from multiple variations in the same
listing, use a separate PlaceOffer request for each variation.
For example, if you want to buy 3 red shirts and 2 black shirts
from the same listing, use one PlaceOffer request for the
3 red shirts, and another PlaceOffer request for the 2
black shirts.
@property (nonatomic, retain) Trading_NameValueListArrayType *variationSpecifics
Discussion
Name-value pairs that identify a single variation within the
listing identified by ItemID. Required when the seller
listed the item with Item Variations.
If you want to buy items from multiple variations in the same
listing, use a separate PlaceOffer request for each variation.
For example, if you want to buy 3 red shirts and 2 black shirts
from the same listing, use one PlaceOffer request for the
3 red shirts, and another PlaceOffer request for the 2
black shirts.
type : class Trading_NameValueListArrayType
Declared In
Trading_PlaceOfferRequestType.h