|
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
- This container specifies the type of offer being made for the listing specified in the ItemID field. The Offer.Action is used to set the action that is being taken on the listing.
ItemID
- Unique identifier that identifies the listing for which the action is being submitted.
BlockOnWarning
- If a warning message is generated when the call is made, this BlockOnWarning will block the bid/buy action if set to true
. If BlockOnWarning
is false
or omitted, the bid/buy action is allowed, regardless of whether or not a warning message occurs.
AffiliateTrackingDetails
- Container for affiliate-related tags, which enable the tracking of user
activity. If you include the AffiliateTrackingDetails container 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
- This container is used to identify a specific variation within a multiple-variation listing identified by the ItemID value. This container is required when attempting to perform an action on a multiple-variation listing.
ReturnedSellingStatus
- This container indicates the current bidding/purchase state of the order line item regarding the offer extended using PlaceOffer. The fields that are returned under this container will depend on the attempted action and the results of that action.
ReturnedTransactionID
- Unique identifier for an eBay order line item. 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. 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. |
java.lang.Boolean |
getBlockOnWarning()
Gets the PlaceOfferRequestType.blockOnWarning. |
java.lang.String |
getItemID()
Gets the PlaceOfferRequestType.itemID. |
OfferType |
getOffer()
Gets the PlaceOfferRequestType.offer. |
BestOfferType |
getReturnedBestOffer()
Valid after executing the API. |
java.lang.String |
getReturnedOrderLineItemID()
Valid after executing the API. |
SellingStatusType |
getReturnedSellingStatus()
Valid after executing the API. |
java.lang.String |
getReturnedTransactionID()
Valid after executing the API. |
NameValueListArrayType |
getVariationSpecifics()
Gets the PlaceOfferRequestType.variationSpecifics. |
SellingStatusType |
placeOffer()
Enables the authenticated user to to make a bid on an auction item, propose a Best Offer, or purchase a fixed-price/Buy It Now item. |
void |
setAffiliateTrackingDetails(AffiliateTrackingDetailsType affiliateTrackingDetails)
Sets the PlaceOfferRequestType.affiliateTrackingDetails. |
void |
setBlockOnWarning(java.lang.Boolean blockOnWarning)
Sets the PlaceOfferRequestType.blockOnWarning. |
void |
setItemID(java.lang.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, java.lang.Exception
ApiException
SdkException
java.lang.Exception
public AffiliateTrackingDetailsType getAffiliateTrackingDetails()
public void setAffiliateTrackingDetails(AffiliateTrackingDetailsType affiliateTrackingDetails)
affiliateTrackingDetails
- AffiliateTrackingDetailsTypepublic java.lang.Boolean getBlockOnWarning()
public void setBlockOnWarning(java.lang.Boolean blockOnWarning)
blockOnWarning
- Booleanpublic java.lang.String getItemID()
public void setItemID(java.lang.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 java.lang.String getReturnedOrderLineItemID()
public SellingStatusType getReturnedSellingStatus()
public java.lang.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.