Changes since
the last release

com.ebay.sdk.call
Class AddSecondChanceItemCall

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

public class AddSecondChanceItemCall
extends ApiCall

Wrapper class of the AddSecondChanceItem 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: RecipientBidderUserID - This field is used to specify the bidder that is being offered the Second Chance Offer. The eBay User ID of the bidder is used in this field. Specify only one RecipientBidderUserID per call. If multiple users are specified, only the last one specified receives the offer. User ID values will be returned in the Offer.User.UserID field of the GetAllBidders call response.
Input property: BuyItNowPrice - The amount the offer recipient must pay to purchase the item as a Second Chance Offer. This field should only be used when the original item was listed in an eBay Motors vehicle category (or in some categories on U.S. and international sites for high-priced items, such as items in many U.S. and Canada Business and Industrial categories) and it ended unsold because the reserve price was not met. Otherwise, eBay establishes the price and no price should be submitted. The price offered to the Second Chance Offer recipient is generally the highest bid that the user made on the original listing.
Input property: Duration - This enumeration value indicates the length of time (in days) that the Second Chance Offer will be available to the recipient. Upon receiving the Second Chance Offer, the recipient bidder will have this many days to accept the offer before the offer expires. One of the values in SecondChanceOfferDurationCodeType must be used.
Input property: ItemID - This field is used to identify the original auction listing through its unique identifier (Item ID). Upon a successful call, the Second Chance Offer will be identified by a new ItemID in the response.
Input property: SellerMessage - This optional field is used to provide a message to the recipient of the Second Chance Offer. This message cannot contain HTML, asterisks, or quotes. The content in this field will be included in the Second Chance Offer email that is sent to the recipient.
Output property: ReturnedItemID - This field contains the Item ID for the Second Chance Offer that was just created with the AddSecondChanceItem call. Note that this Item ID will be different from the Item ID in the original auction listing that was passed in the request.
Output property: ReturnedStartTime - This timestamp indicates the date and time when the Second Chance Offer became available to the recipient.
Output property: ReturnedEndTime - This timestamp indicates the date and time when the Second Chance Offer listing will expire, at which time the recipient will no longer be able to purchase the item.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
AddSecondChanceItemCall()
          Constructor.
AddSecondChanceItemCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 java.lang.String addSecondChanceItem()
          Used by the seller of an auction listing to provide a Second Chance Offer to one of that auction item's non-winning bidders.
 AmountType getBuyItNowPrice()
          Gets the AddSecondChanceItemRequestType.buyItNowPrice.
 SecondChanceOfferDurationCodeType getDuration()
          Gets the AddSecondChanceItemRequestType.duration.
 java.lang.String getItemID()
          Gets the AddSecondChanceItemRequestType.itemID.
 java.lang.String getRecipientBidderUserID()
          Gets the AddSecondChanceItemRequestType.recipientBidderUserID.
 java.util.Calendar getReturnedEndTime()
          Valid after executing the API.
 java.lang.String getReturnedItemID()
          Valid after executing the API.
 java.util.Calendar getReturnedStartTime()
          Valid after executing the API.
 java.lang.String getSellerMessage()
          Gets the AddSecondChanceItemRequestType.sellerMessage.
 void setBuyItNowPrice(AmountType buyItNowPrice)
          Sets the AddSecondChanceItemRequestType.buyItNowPrice.
 void setDuration(SecondChanceOfferDurationCodeType duration)
          Sets the AddSecondChanceItemRequestType.duration.
 void setItemID(java.lang.String itemID)
          Sets the AddSecondChanceItemRequestType.itemID.
 void setRecipientBidderUserID(java.lang.String recipientBidderUserID)
          Sets the AddSecondChanceItemRequestType.recipientBidderUserID.
 void setSellerMessage(java.lang.String sellerMessage)
          Sets the AddSecondChanceItemRequestType.sellerMessage.
 void verifyAddSecondChanceItem()
          Executes VerifyAddSecondChanceItem API.
 
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

AddSecondChanceItemCall

public AddSecondChanceItemCall()
Constructor.


AddSecondChanceItemCall

public AddSecondChanceItemCall(ApiContext apiContext)
Constructor.

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

addSecondChanceItem

public java.lang.String addSecondChanceItem()
                                     throws ApiException,
                                            SdkException,
                                            java.lang.Exception
Used by the seller of an auction listing to provide a Second Chance Offer to one of that auction item's non-winning bidders. A Second Chance Offer is used by sellers whenever the seller was unable to complete the sale with the winning bidder because the bidder didn't pay, or if the auction listing ended without the Reserve Price being met, or if that seller has multiple identical items for sale and wants to give other bidders a chance to purchase the item.

To get information on the bidders for a recently-ended auction listing, the seller can use the GetAllBidders call and pass the corresponding ItemID value into the call request.

For more information on the specifics of Second Chance Offers, see the Making a Second Chance Offer help page.

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

getBuyItNowPrice

public AmountType getBuyItNowPrice()
Gets the AddSecondChanceItemRequestType.buyItNowPrice.

Returns:
AmountType

setBuyItNowPrice

public void setBuyItNowPrice(AmountType buyItNowPrice)
Sets the AddSecondChanceItemRequestType.buyItNowPrice.

Parameters:
buyItNowPrice - AmountType

getDuration

public SecondChanceOfferDurationCodeType getDuration()
Gets the AddSecondChanceItemRequestType.duration.

Returns:
SecondChanceOfferDurationCodeType

setDuration

public void setDuration(SecondChanceOfferDurationCodeType duration)
Sets the AddSecondChanceItemRequestType.duration.

Parameters:
duration - SecondChanceOfferDurationCodeType

getItemID

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

Returns:
String

setItemID

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

Parameters:
itemID - String

getRecipientBidderUserID

public java.lang.String getRecipientBidderUserID()
Gets the AddSecondChanceItemRequestType.recipientBidderUserID.

Returns:
String

setRecipientBidderUserID

public void setRecipientBidderUserID(java.lang.String recipientBidderUserID)
Sets the AddSecondChanceItemRequestType.recipientBidderUserID.

Parameters:
recipientBidderUserID - String

getSellerMessage

public java.lang.String getSellerMessage()
Gets the AddSecondChanceItemRequestType.sellerMessage.

Returns:
String

setSellerMessage

public void setSellerMessage(java.lang.String sellerMessage)
Sets the AddSecondChanceItemRequestType.sellerMessage.

Parameters:
sellerMessage - String

verifyAddSecondChanceItem

public void verifyAddSecondChanceItem()
                               throws ApiException,
                                      SdkException,
                                      java.lang.Exception
Executes VerifyAddSecondChanceItem API. This call is used to evaluate listing fees without actually making the second chance offer.

Throws:
ApiException
SdkException
java.lang.Exception

getReturnedEndTime

public java.util.Calendar getReturnedEndTime()
Valid after executing the API. Gets the returned AddSecondChanceItemResponseType.returnedEndTime.

Returns:
Calendar

getReturnedItemID

public java.lang.String getReturnedItemID()
Valid after executing the API. Gets the returned AddSecondChanceItemResponseType.returnedItemID.

Returns:
String

getReturnedStartTime

public java.util.Calendar getReturnedStartTime()
Valid after executing the API. Gets the returned AddSecondChanceItemResponseType.returnedStartTime.

Returns:
Calendar

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.