Changes since
the last release

com.ebay.sdk.call
Class RespondToBestOfferCall

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

public class RespondToBestOfferCall
extends ApiCall

Wrapper class of the RespondToBestOffer 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: ItemID - The unique identifier of the listing to which the seller is responding about a Best Offer.
Input property: BestOfferIDs - The unique identifier of a buyer's Best Offer for the item. This ID is created once the buyer makes a Best Offer. It is possible that a seller will get multiple Best Offers for an item, and if that seller would like to decline multiple/all of the Best Offers with one RespondToBestOffer call, the seller would pass in each of these identifiers in a separate BestOfferID field. However, the seller can only accept or counter offer one Best Offer at a time.
Input property: BestOfferAction - The enumeration value that the seller passes in to this field will control whether the seller accepts or make a counter offer to a single buyer's Best Offer, or declines one or more buyers' Best Offers. A seller can decline multiple Best Offers with one call, but the seller cannot accept or counter offer multiple Best Offers with one call.
Input property: SellerResponse - This optional text field allows the seller to provide more details to the buyer about the action being taken against the buyer's Best Offer.
Input property: CounterOfferPrice - The seller inserts counter offer price into this field. This field is conditionally required and only applicable when the Action value is set to Counter, The counter offer price cannot exceed the Buy It Now price for a single quantity item. However, the dollar value in this field may exceed the Buy It Now price if the buyer is requesting or the seller is offering multiple quantity of the item (in a multiple-quantity listing). The quantity of the item must be specified in the CounterOfferQuantity field if the seller is making a counter offer.
Input property: CounterOfferQuantity - The seller inserts the quantity of items in the counter offer into this field. This field is conditionally required and only applicable when the Action value is set to Counter, The counter offer price must be specified in the CounterOfferPrice field if the seller is making a counter offer. This price should reflect the quantity of items in the counter offer. So, if the seller's counter offer 'unit' price is 15 dollars, and the item quantity is '2', the dollar value passed into the CounterOfferPrice field would be 30.0.
Output property: ReturnedBestOffers - The BestOffer.CallStatus value returned in this container will indicate whether or not the action specified in the call request (accept, decline, or counter offer) was successful. The accept and counter offer actions can only be applied toward a single Best Offer. However, multiple Best Offers on a listing can be declined with one call. All Best Offers must be successfully declined with the RespondToBestOffer call for the BestOffer.CallStatus value to be Success.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
RespondToBestOfferCall()
          Constructor.
RespondToBestOfferCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 BestOfferActionCodeType getBestOfferAction()
          Gets the RespondToBestOfferRequestType.bestOfferAction.
 String[] getBestOfferIDs()
          Gets the RespondToBestOfferRequestType.bestOfferIDs.
 AmountType getCounterOfferPrice()
          Gets the RespondToBestOfferRequestType.counterOfferPrice.
 Integer getCounterOfferQuantity()
          Gets the RespondToBestOfferRequestType.counterOfferQuantity.
 String getItemID()
          Gets the RespondToBestOfferRequestType.itemID.
 BestOfferType[] getReturnedBestOffers()
          Valid after executing the API.
 String getSellerResponse()
          Gets the RespondToBestOfferRequestType.sellerResponse.
 void respondToBestOffer()
          This call enables the seller to accept or decline a buyer's Best Offer on an item, or make a counter offer to the buyer's Best Offer.
 void setBestOfferAction(BestOfferActionCodeType bestOfferAction)
          Sets the RespondToBestOfferRequestType.bestOfferAction.
 void setBestOfferIDs(String[] bestOfferIDs)
          Sets the RespondToBestOfferRequestType.bestOfferIDs.
 void setCounterOfferPrice(AmountType counterOfferPrice)
          Sets the RespondToBestOfferRequestType.counterOfferPrice.
 void setCounterOfferQuantity(Integer counterOfferQuantity)
          Sets the RespondToBestOfferRequestType.counterOfferQuantity.
 void setItemID(String itemID)
          Sets the RespondToBestOfferRequestType.itemID.
 void setSellerResponse(String sellerResponse)
          Sets the RespondToBestOfferRequestType.sellerResponse.
 
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

RespondToBestOfferCall

public RespondToBestOfferCall()
Constructor.


RespondToBestOfferCall

public RespondToBestOfferCall(ApiContext apiContext)
Constructor.

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

respondToBestOffer

public void respondToBestOffer()
                        throws ApiException,
                               SdkException,
                               Exception
This call enables the seller to accept or decline a buyer's Best Offer on an item, or make a counter offer to the buyer's Best Offer. A seller can decline multiple Best Offers with one call, but the seller cannot accept or counter offer multiple Best Offers with one call. Best Offers are not applicable to auction listings.

Note: Historically, the Best Offer feature has not been available for auction listings, but beginning with Version 1027, scheduled to roll out the first week in August 2017, sellers in the US, UK, and DE sites will be able to offer the Best Offer feature in auction listings. Once this new capability rolls out, the seller can offer Buy It Now or Best Offer in an auction listing, but not both.

Throws:
ApiException
SdkException
Exception

getBestOfferAction

public BestOfferActionCodeType getBestOfferAction()
Gets the RespondToBestOfferRequestType.bestOfferAction.

Returns:
BestOfferActionCodeType

setBestOfferAction

public void setBestOfferAction(BestOfferActionCodeType bestOfferAction)
Sets the RespondToBestOfferRequestType.bestOfferAction.

Parameters:
bestOfferAction - BestOfferActionCodeType

getBestOfferIDs

public String[] getBestOfferIDs()
Gets the RespondToBestOfferRequestType.bestOfferIDs.

Returns:
String[]

setBestOfferIDs

public void setBestOfferIDs(String[] bestOfferIDs)
Sets the RespondToBestOfferRequestType.bestOfferIDs.

Parameters:
bestOfferIDs - String[]

getCounterOfferPrice

public AmountType getCounterOfferPrice()
Gets the RespondToBestOfferRequestType.counterOfferPrice.

Returns:
AmountType

setCounterOfferPrice

public void setCounterOfferPrice(AmountType counterOfferPrice)
Sets the RespondToBestOfferRequestType.counterOfferPrice.

Parameters:
counterOfferPrice - AmountType

getCounterOfferQuantity

public Integer getCounterOfferQuantity()
Gets the RespondToBestOfferRequestType.counterOfferQuantity.

Returns:
Integer

setCounterOfferQuantity

public void setCounterOfferQuantity(Integer counterOfferQuantity)
Sets the RespondToBestOfferRequestType.counterOfferQuantity.

Parameters:
counterOfferQuantity - Integer

getItemID

public String getItemID()
Gets the RespondToBestOfferRequestType.itemID.

Returns:
String

setItemID

public void setItemID(String itemID)
Sets the RespondToBestOfferRequestType.itemID.

Parameters:
itemID - String

getSellerResponse

public String getSellerResponse()
Gets the RespondToBestOfferRequestType.sellerResponse.

Returns:
String

setSellerResponse

public void setSellerResponse(String sellerResponse)
Sets the RespondToBestOfferRequestType.sellerResponse.

Parameters:
sellerResponse - String

getReturnedBestOffers

public BestOfferType[] getReturnedBestOffers()
Valid after executing the API. Gets the returned RespondToBestOfferResponseType.returnedBestOffers.

Returns:
BestOfferType[]

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.