|
Changes since the last release |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ebay.sdk.ApiCall
com.ebay.sdk.call.PlaceOfferCall
public class PlaceOfferCall
Wrapper class of the PlaceOffer call of eBay SOAP API.
Title: SOAP API wrapper library.
Description: Contains wrapper classes for eBay SOAP APIs.
Copyright: Copyright (c) 2009
Company: eBay Inc.
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.
ItemID
- Unique item ID that identifies the item listing for which the action is being
submitted.
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.
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.
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.ReturnedSellingStatus
- Indicates the current bidding/purchase state of the item listing regarding
the offer extended using PlaceOffer. See the schema documentation for
the SellingStatus object, the properties of which contain such
post-offer information as the current high bidder, the current price for
the item, and the bid increment.
ReturnedTransactionID
- Unique identifier for an eBay order line item (transaction). The
TransactionID field is only returned if the Offer.Action field was set
to Purchase in the input and the purchase was successful. A Purchase
action in PlaceOffer can be used for a fixed-price listing, or for an
auction listing where the Buy It Now option is available.
ReturnedBestOffer
- Container consisting of the status for a Best Offer. This container is
only returned if applicable based on the listing and the value set for
Offer.Action field in the request.
ReturnedOrderLineItemID
- OrderLineItemID is a unique identifier for an eBay order line item and
is based upon the concatenation of ItemID and TransactionID, with a
hyphen in between these two IDs. The OrderLineItemID field is only
returned if the Offer.Action field is set to Purchase in the input and
the purchase is successful. A Purchase action in PlaceOffer can be used
for a fixed-price listing, or for an auction listing where the Buy It
Now option is available.
Field Summary |
---|
Fields inherited from class com.ebay.sdk.ApiCall |
---|
apiException, sendReqListeners |
Constructor Summary | |
---|---|
PlaceOfferCall()
Constructor. |
|
PlaceOfferCall(ApiContext apiContext)
Constructor. |
Method Summary | |
---|---|
AffiliateTrackingDetailsType |
getAffiliateTrackingDetails()
Gets the PlaceOfferRequestType.affiliateTrackingDetails. |
Boolean |
getBlockOnWarning()
Gets the PlaceOfferRequestType.blockOnWarning. |
String |
getItemID()
Gets the PlaceOfferRequestType.itemID. |
OfferType |
getOffer()
Gets the PlaceOfferRequestType.offer. |
BestOfferType |
getReturnedBestOffer()
Valid after executing the API. |
String |
getReturnedOrderLineItemID()
Valid after executing the API. |
SellingStatusType |
getReturnedSellingStatus()
Valid after executing the API. |
String |
getReturnedTransactionID()
Valid after executing the API. |
NameValueListArrayType |
getVariationSpecifics()
Gets the PlaceOfferRequestType.variationSpecifics. |
SellingStatusType |
placeOffer()
Enables the authenticated user to to make a bid, a Best Offer, or a purchase on the item specified by the ItemID input field. |
void |
setAffiliateTrackingDetails(AffiliateTrackingDetailsType affiliateTrackingDetails)
Sets the PlaceOfferRequestType.affiliateTrackingDetails. |
void |
setBlockOnWarning(Boolean blockOnWarning)
Sets the PlaceOfferRequestType.blockOnWarning. |
void |
setItemID(String itemID)
Sets the PlaceOfferRequestType.itemID. |
void |
setOffer(OfferType offer)
Sets the PlaceOfferRequestType.offer. |
void |
setVariationSpecifics(NameValueListArrayType variationSpecifics)
Sets the PlaceOfferRequestType.variationSpecifics. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public PlaceOfferCall()
public PlaceOfferCall(ApiContext apiContext)
apiContext
- The ApiContext object to be used to make the call.Method Detail |
---|
public SellingStatusType placeOffer() throws ApiException, SdkException, Exception
ApiException
SdkException
Exception
public AffiliateTrackingDetailsType getAffiliateTrackingDetails()
public void setAffiliateTrackingDetails(AffiliateTrackingDetailsType affiliateTrackingDetails)
affiliateTrackingDetails
- AffiliateTrackingDetailsTypepublic Boolean getBlockOnWarning()
public void setBlockOnWarning(Boolean blockOnWarning)
blockOnWarning
- Booleanpublic String getItemID()
public void setItemID(String itemID)
itemID
- Stringpublic OfferType getOffer()
public void setOffer(OfferType offer)
offer
- OfferTypepublic NameValueListArrayType getVariationSpecifics()
public void setVariationSpecifics(NameValueListArrayType variationSpecifics)
variationSpecifics
- NameValueListArrayTypepublic BestOfferType getReturnedBestOffer()
public String getReturnedOrderLineItemID()
public SellingStatusType getReturnedSellingStatus()
public String getReturnedTransactionID()
|
Changes since the last release |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The information contained in this document is proprietary and confidential.
Use of this information and the eBay API requires a Non-Disclosure Agreement (NDA) between the user and eBay Inc.
For information regarding a qualifying NDA, contact Developer Relations:
developer-relations@ebay.com
© 2004-2009 eBay Inc. All rights reserved.