|
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.RespondToBestOfferCall
public class RespondToBestOfferCall
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.
ItemID
- The unique identifier of the listing to which the seller is responding to a Best Offer.
BestOfferIDs
- The unique identifier of a buyer's Best Offer for the order line 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 order line 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.
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.
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.
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.
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
.
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
.
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. |
java.lang.String[] |
getBestOfferIDs()
Gets the RespondToBestOfferRequestType.bestOfferIDs. |
AmountType |
getCounterOfferPrice()
Gets the RespondToBestOfferRequestType.counterOfferPrice. |
java.lang.Integer |
getCounterOfferQuantity()
Gets the RespondToBestOfferRequestType.counterOfferQuantity. |
java.lang.String |
getItemID()
Gets the RespondToBestOfferRequestType.itemID. |
BestOfferType[] |
getReturnedBestOffers()
Valid after executing the API. |
java.lang.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(java.lang.String[] bestOfferIDs)
Sets the RespondToBestOfferRequestType.bestOfferIDs. |
void |
setCounterOfferPrice(AmountType counterOfferPrice)
Sets the RespondToBestOfferRequestType.counterOfferPrice. |
void |
setCounterOfferQuantity(java.lang.Integer counterOfferQuantity)
Sets the RespondToBestOfferRequestType.counterOfferQuantity. |
void |
setItemID(java.lang.String itemID)
Sets the RespondToBestOfferRequestType.itemID. |
void |
setSellerResponse(java.lang.String sellerResponse)
Sets the RespondToBestOfferRequestType.sellerResponse. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public RespondToBestOfferCall()
public RespondToBestOfferCall(ApiContext apiContext)
apiContext
- The ApiContext object to be used to make the call.Method Detail |
---|
public void respondToBestOffer() throws ApiException, SdkException, java.lang.Exception
ApiException
SdkException
java.lang.Exception
public BestOfferActionCodeType getBestOfferAction()
public void setBestOfferAction(BestOfferActionCodeType bestOfferAction)
bestOfferAction
- BestOfferActionCodeTypepublic java.lang.String[] getBestOfferIDs()
public void setBestOfferIDs(java.lang.String[] bestOfferIDs)
bestOfferIDs
- String[]public AmountType getCounterOfferPrice()
public void setCounterOfferPrice(AmountType counterOfferPrice)
counterOfferPrice
- AmountTypepublic java.lang.Integer getCounterOfferQuantity()
public void setCounterOfferQuantity(java.lang.Integer counterOfferQuantity)
counterOfferQuantity
- Integerpublic java.lang.String getItemID()
public void setItemID(java.lang.String itemID)
itemID
- Stringpublic java.lang.String getSellerResponse()
public void setSellerResponse(java.lang.String sellerResponse)
sellerResponse
- Stringpublic BestOfferType[] getReturnedBestOffers()
|
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.