Changes since
the last release

com.ebay.sdk.call
Class PlaceOfferCall

java.lang.Object
  extended by com.ebay.sdk.ApiCall
      extended by com.ebay.sdk.call.PlaceOfferCall

public class PlaceOfferCall
extends ApiCall

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.


Input property: Offer - This container is used to 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.
Input property: ItemID - Unique identifier that identifies the listing for which the action is being submitted.

For a multiple-variation listing, you must also identify the specific variation within that listing using the VariationSpecifics container.
Input property: 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.

Input property: 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.
Input property: 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.
Output property: 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.
Output property: 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.
Output property: 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.
Output property: 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.

Version:
1.0
Author:
Ron Murphy

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 com.ebay.sdk.ApiCall
addDetailLevel, addSendRequestListener, execute, executeByApiName, getApiContext, getApiException, getBotBlock, getCallRetry, getDetailLevel, getEnableCompression, getEndUserIP, getErrorHandling, getInvocationID, getMessageID, getOutputSelector, getRequestXml, getResponseObject, getResponseXml, getSite, getWarningLevel, hasError, hasWarning, isEnableoAuthTokenHTTPHeader, removeSendRequestListener, setApiContext, setBotBlock, setCallRetry, setDetailLevel, setEnableCompression, setEnableoAuthTokenHTTPHeader, setEndUserIP, setErrorHandling, setInvocationID, setMessageID, setOutputSelector, setSite, setWarningLevel
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PlaceOfferCall

public PlaceOfferCall()
Constructor.


PlaceOfferCall

public PlaceOfferCall(ApiContext apiContext)
Constructor.

Parameters:
apiContext - The ApiContext object to be used to make the call.
Method Detail

placeOffer

public SellingStatusType placeOffer()
                             throws ApiException,
                                    SdkException,
                                    java.lang.Exception
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. Note that this call cannot be used to purchase items that require immediate payment.

Returns:
The SellingStatusType object.
Throws:
ApiException
SdkException
java.lang.Exception

getAffiliateTrackingDetails

public AffiliateTrackingDetailsType getAffiliateTrackingDetails()
Gets the PlaceOfferRequestType.affiliateTrackingDetails.

Returns:
AffiliateTrackingDetailsType

setAffiliateTrackingDetails

public void setAffiliateTrackingDetails(AffiliateTrackingDetailsType affiliateTrackingDetails)
Sets the PlaceOfferRequestType.affiliateTrackingDetails.

Parameters:
affiliateTrackingDetails - AffiliateTrackingDetailsType

getBlockOnWarning

public java.lang.Boolean getBlockOnWarning()
Gets the PlaceOfferRequestType.blockOnWarning.

Returns:
Boolean

setBlockOnWarning

public void setBlockOnWarning(java.lang.Boolean blockOnWarning)
Sets the PlaceOfferRequestType.blockOnWarning.

Parameters:
blockOnWarning - Boolean

getItemID

public java.lang.String getItemID()
Gets the PlaceOfferRequestType.itemID.

Returns:
String

setItemID

public void setItemID(java.lang.String itemID)
Sets the PlaceOfferRequestType.itemID.

Parameters:
itemID - String

getOffer

public OfferType getOffer()
Gets the PlaceOfferRequestType.offer.

Returns:
OfferType

setOffer

public void setOffer(OfferType offer)
Sets the PlaceOfferRequestType.offer.

Parameters:
offer - OfferType

getVariationSpecifics

public NameValueListArrayType getVariationSpecifics()
Gets the PlaceOfferRequestType.variationSpecifics.

Returns:
NameValueListArrayType

setVariationSpecifics

public void setVariationSpecifics(NameValueListArrayType variationSpecifics)
Sets the PlaceOfferRequestType.variationSpecifics.

Parameters:
variationSpecifics - NameValueListArrayType

getReturnedBestOffer

public BestOfferType getReturnedBestOffer()
Valid after executing the API. Gets the returned PlaceOfferResponseType.returnedBestOffer.

Returns:
BestOfferType

getReturnedOrderLineItemID

public java.lang.String getReturnedOrderLineItemID()
Valid after executing the API. Gets the returned PlaceOfferResponseType.returnedOrderLineItemID.

Returns:
String

getReturnedSellingStatus

public SellingStatusType getReturnedSellingStatus()
Valid after executing the API. Gets the returned PlaceOfferResponseType.returnedSellingStatus.

Returns:
SellingStatusType

getReturnedTransactionID

public java.lang.String getReturnedTransactionID()
Valid after executing the API. Gets the returned PlaceOfferResponseType.returnedTransactionID.

Returns:
String

Changes since
the last release

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.