Changes since
the last release

com.ebay.sdk.call
Class AddTransactionConfirmationItemCall

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

public class AddTransactionConfirmationItemCall
extends ApiCall

Wrapper class of the AddTransactionConfirmationItem 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: RecipientUserID - This field is used to specify the recipient of the Transaction Confirmation Request (TCR).
Input property: VerifyEligibilityOnly - This field is included and set to true if the seller wants to verify whether or not a new Transaction Confirmation Request (TCR) can be created for the item. If this field is included and its value set to true, no TCR is actually created. If this field is included and its value set to false, or if it is omitted, a Transaction Confirmation Request is actually created.
Input property: RecipientPostalCode - This field is used to specify the postal code of the user to whom the seller is offering the Transaction Confirmation Request. This field is only required if the user does not meet the other options listed in RecipientRelationCodeType.
Input property: RecipientRelationType - The enumeration value supplied in this field specifies the current relationship between the seller and the potential buyer. A Transaction Confirmation Request (TCR) for an item can be sent to a potential buyer who has at least one of the following criteria: is an active bidder on the auction listing; has made a Best Offer on the fixed-price listing, is an eBay user who has used the Ask Seller a Question feature, or is an eBay user whose postal code is known.
Input property: NegotiatedPrice - The amount in this field is the price that the seller is asking for to purchase the motor vehicle.
Input property: ListingDuration - The enumeration value specified in this field will control how many days that the recipient of the offer has to purchase the motor vehicle at the price listed in the NegotiatedPrice field.
Input property: ItemID - This field is used to identify the eBay Motors listing using the unique identifier of the listing (ItemID).
Input property: Comments - This is optional free-form string field that can be used by the seller to provide any comments or additional information about the Transaction Confirmation Item.
Output property: ReturnedItemID - This field contains the Item ID associated with the Transaction Confirmation Item that was just created with the AddTransactionConfirmationItem call. This field is not returned if the request was only used to verify that a new TCR could be created.
Output property: ReturnedStartTime - This timestamp indicates the date and time when the Transaction Confirmation Item became available to the recipient.
Output property: ReturnedEndTime - This timestamp indicates the date and time when the Transaction Confirmation Item will no longer be available for purchase.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
AddTransactionConfirmationItemCall()
          Constructor.
AddTransactionConfirmationItemCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 String addTransactionConfirmationItem()
          Base request of the AddTransactionConfirmationItem call, which is used to end an eBay Motors listing and creates a new Transaction Confirmation Request (TCR) for the motor vehichle, thus enabling the TCR recipient to purchase the item.
 String getComments()
          Gets the AddTransactionConfirmationItemRequestType.comments.
 String getItemID()
          Gets the AddTransactionConfirmationItemRequestType.itemID.
 SecondChanceOfferDurationCodeType getListingDuration()
          Gets the AddTransactionConfirmationItemRequestType.listingDuration.
 AmountType getNegotiatedPrice()
          Gets the AddTransactionConfirmationItemRequestType.negotiatedPrice.
 String getRecipientPostalCode()
          Gets the AddTransactionConfirmationItemRequestType.recipientPostalCode.
 String getRecipientRelationType()
          Gets the AddTransactionConfirmationItemRequestType.recipientRelationType.
 String getRecipientUserID()
          Gets the AddTransactionConfirmationItemRequestType.recipientUserID.
 Calendar getReturnedEndTime()
          Valid after executing the API.
 String getReturnedItemID()
          Valid after executing the API.
 Calendar getReturnedStartTime()
          Valid after executing the API.
 String getVerifyEligibilityOnly()
          Gets the AddTransactionConfirmationItemRequestType.verifyEligibilityOnly.
 void setComments(String comments)
          Sets the AddTransactionConfirmationItemRequestType.comments.
 void setItemID(String itemID)
          Sets the AddTransactionConfirmationItemRequestType.itemID.
 void setListingDuration(SecondChanceOfferDurationCodeType listingDuration)
          Sets the AddTransactionConfirmationItemRequestType.listingDuration.
 void setNegotiatedPrice(AmountType negotiatedPrice)
          Sets the AddTransactionConfirmationItemRequestType.negotiatedPrice.
 void setRecipientPostalCode(String recipientPostalCode)
          Sets the AddTransactionConfirmationItemRequestType.recipientPostalCode.
 void setRecipientRelationType(String recipientRelationType)
          Sets the AddTransactionConfirmationItemRequestType.recipientRelationType.
 void setRecipientUserID(String recipientUserID)
          Sets the AddTransactionConfirmationItemRequestType.recipientUserID.
 void setVerifyEligibilityOnly(String verifyEligibilityOnly)
          Sets the AddTransactionConfirmationItemRequestType.verifyEligibilityOnly.
 
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

AddTransactionConfirmationItemCall

public AddTransactionConfirmationItemCall()
Constructor.


AddTransactionConfirmationItemCall

public AddTransactionConfirmationItemCall(ApiContext apiContext)
Constructor.

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

addTransactionConfirmationItem

public String addTransactionConfirmationItem()
                                      throws ApiException,
                                             SdkException,
                                             Exception
Base request of the AddTransactionConfirmationItem call, which is used to end an eBay Motors listing and creates a new Transaction Confirmation Request (TCR) for the motor vehichle, thus enabling the TCR recipient to purchase the item. You can also use this call to see if a new TCR can be created for the specified item.

Returns:
The String object.
Throws:
ApiException
SdkException
Exception

getComments

public String getComments()
Gets the AddTransactionConfirmationItemRequestType.comments.

Returns:
String

setComments

public void setComments(String comments)
Sets the AddTransactionConfirmationItemRequestType.comments.

Parameters:
comments - String

getItemID

public String getItemID()
Gets the AddTransactionConfirmationItemRequestType.itemID.

Returns:
String

setItemID

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

Parameters:
itemID - String

getListingDuration

public SecondChanceOfferDurationCodeType getListingDuration()
Gets the AddTransactionConfirmationItemRequestType.listingDuration.

Returns:
SecondChanceOfferDurationCodeType

setListingDuration

public void setListingDuration(SecondChanceOfferDurationCodeType listingDuration)
Sets the AddTransactionConfirmationItemRequestType.listingDuration.

Parameters:
listingDuration - SecondChanceOfferDurationCodeType

getNegotiatedPrice

public AmountType getNegotiatedPrice()
Gets the AddTransactionConfirmationItemRequestType.negotiatedPrice.

Returns:
AmountType

setNegotiatedPrice

public void setNegotiatedPrice(AmountType negotiatedPrice)
Sets the AddTransactionConfirmationItemRequestType.negotiatedPrice.

Parameters:
negotiatedPrice - AmountType

getRecipientPostalCode

public String getRecipientPostalCode()
Gets the AddTransactionConfirmationItemRequestType.recipientPostalCode.

Returns:
String

setRecipientPostalCode

public void setRecipientPostalCode(String recipientPostalCode)
Sets the AddTransactionConfirmationItemRequestType.recipientPostalCode.

Parameters:
recipientPostalCode - String

getRecipientRelationType

public String getRecipientRelationType()
Gets the AddTransactionConfirmationItemRequestType.recipientRelationType.

Returns:
String

setRecipientRelationType

public void setRecipientRelationType(String recipientRelationType)
Sets the AddTransactionConfirmationItemRequestType.recipientRelationType.

Parameters:
recipientRelationType - String

getRecipientUserID

public String getRecipientUserID()
Gets the AddTransactionConfirmationItemRequestType.recipientUserID.

Returns:
String

setRecipientUserID

public void setRecipientUserID(String recipientUserID)
Sets the AddTransactionConfirmationItemRequestType.recipientUserID.

Parameters:
recipientUserID - String

getVerifyEligibilityOnly

public String getVerifyEligibilityOnly()
Gets the AddTransactionConfirmationItemRequestType.verifyEligibilityOnly.

Returns:
String

setVerifyEligibilityOnly

public void setVerifyEligibilityOnly(String verifyEligibilityOnly)
Sets the AddTransactionConfirmationItemRequestType.verifyEligibilityOnly.

Parameters:
verifyEligibilityOnly - String

getReturnedEndTime

public Calendar getReturnedEndTime()
Valid after executing the API. Gets the returned AddTransactionConfirmationItemResponseType.returnedEndTime.

Returns:
Calendar

getReturnedItemID

public String getReturnedItemID()
Valid after executing the API. Gets the returned AddTransactionConfirmationItemResponseType.returnedItemID.

Returns:
String

getReturnedStartTime

public Calendar getReturnedStartTime()
Valid after executing the API. Gets the returned AddTransactionConfirmationItemResponseType.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.