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 - 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.
Input property: 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.
Input property: 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.
Input property: 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.
Input property: 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.
Output property: 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.
Output property: 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.
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.
 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 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, removeSendRequestListener, setApiContext, setBotBlock, setCallRetry, setDetailLevel, setEnableCompression, 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,
                                    Exception
Enables the authenticated user to to make a bid, a Best Offer, or a purchase on the item specified by the ItemID input field.

Returns:
The SellingStatusType object.
Throws:
ApiException
SdkException
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 Boolean getBlockOnWarning()
Gets the PlaceOfferRequestType.blockOnWarning.

Returns:
Boolean

setBlockOnWarning

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

Parameters:
blockOnWarning - Boolean

getItemID

public String getItemID()
Gets the PlaceOfferRequestType.itemID.

Returns:
String

setItemID

public void setItemID(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 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 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.