com.ebay.sdk.call
Class AddTransactionConfirmationItemCall

java.lang.Object
  com.ebay.sdk.ApiCall
      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) 2007

Company: eBay Inc.

Input property: RecipientUserID - Specifies the user to whom the seller is offering the Transaction Confirmation Request.
Input property: VerifyEligibilityOnly - If true, specifies that the seller is verifying whether a new Transaction Confirmation Request (TCR) can be created. Thus, if this value is passed as true, then no Transaction Confirmation Request is actually made. If VerifyEligibilityOnly is not passed, or is false, a Transaction Confirmation Request is actually made.
Input property: RecipientPostalCode - Specifies the postal code of the user to whom the seller is offering the Transaction Confirmation Request. Required only if the user does not meet the other options listed in RecipientRelationCodeType. An error is returned if RecipientUserID and RecipientPostalCode do not match for more than 3 times for a seller per day.
Input property: RecipientRelationType - Specifies the current relationship between the seller and the potential buyer. A seller can make a Transaction Confirmation Request (TCR) for an item to a potential buyer if the buyer meets one of several criteria. A TCR is sent by a seller to one of the following: a bidder, a best offer buyer, a member with an ASQ question, or any member with a postal code. See the values and annotations in RecipientRelationCodeType.
Input property: NegotiatedPrice - The amount the offer recipient must pay to buy the item specified in the Transaction Confirmation Request (TCR). A negotiated amount between the buyer and the seller.
Input property: ListingDuration - Specifies the length of time the item in the Transaction Confirmation Request (TCR) will be available for purchase.
Input property: ItemID - The ItemID of the item that the seller wants to end in order to create a Transaction Confirmation Request (TCR).
Input property: Comments - Comments the seller wants to send to the recipient (bidder, best offer buyer, member with an ASQ question, or member with a postal code).
Output property: ReturnedItemID - The new item ID for the item in the new Transaction Confirmation Request (TCR). This field is not returned if the request was only used to verify that a new TCR could be created.
Output property: ReturnedStartTime - The date and time when the item in the new Transaction Confirmation Request (TCR) becomes available for purchase.
Output property: ReturnedEndTime - The date and time when the item in the new Transaction Confirmation Request (TCR) is no longer available for purchase.

Field Summary

Fields inherited from class com.ebay.sdk.ApiCall

apiException, sendReqListeners

Constructor Summary

AddTransactionConfirmationItemCall()
Constructor.

AddTransactionConfirmationItemCall(ApiContext apiContext)
Constructor.

Method Summary

ItemIDType	addTransactionConfirmationItem() Ends the listing specified by ItemID (if listed for at least 24 hours) and creates a new Transaction Confirmation Request (TCR) for an item, enabling the TCR recipient to purchase the item.
String	getComments() Gets the AddTransactionConfirmationItemRequestType.comments.
ItemIDType	getItemID() Gets the AddTransactionConfirmationItemRequestType.itemID.
SecondChanceOfferDurationCodeType	getListingDuration() Gets the AddTransactionConfirmationItemRequestType.listingDuration.
AmountType	getNegotiatedPrice() Gets the AddTransactionConfirmationItemRequestType.negotiatedPrice.
String	getRecipientPostalCode() Gets the AddTransactionConfirmationItemRequestType.recipientPostalCode.
RecipientRelationCodeType	getRecipientRelationType() Gets the AddTransactionConfirmationItemRequestType.recipientRelationType.
UserIDType	getRecipientUserID() Gets the AddTransactionConfirmationItemRequestType.recipientUserID.
Calendar	getReturnedEndTime() Valid after executing the API.
ItemIDType	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(ItemIDType 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(RecipientRelationCodeType recipientRelationType) Sets the AddTransactionConfirmationItemRequestType.recipientRelationType.
void	setRecipientUserID(UserIDType 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 ItemIDType addTransactionConfirmationItem()
                                          throws ApiException,
                                                 SdkException,
                                                 Exception

Ends the listing specified by ItemID (if listed for at least 24 hours) and creates a new Transaction Confirmation Request (TCR) for an item, enabling the TCR recipient to purchase the item. A TCR can be sent by a seller to any one of the following: a bidder, a best offer buyer, a member who has asked the seller a question, or any member with a postal code. This call can also be used to verify whether a new TCR can be created. Applies to the US eBay Motors site (except Parts and Accessories category).

Returns:

The ItemIDType 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 ItemIDType getItemID()

Gets the AddTransactionConfirmationItemRequestType.itemID.

Returns:

ItemIDType

setItemID

public void setItemID(ItemIDType itemID)

Sets the AddTransactionConfirmationItemRequestType.itemID.

Parameters:

itemID - ItemIDType

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 RecipientRelationCodeType getRecipientRelationType()

Gets the AddTransactionConfirmationItemRequestType.recipientRelationType.

Returns:

RecipientRelationCodeType

setRecipientRelationType

public void setRecipientRelationType(RecipientRelationCodeType recipientRelationType)

Sets the AddTransactionConfirmationItemRequestType.recipientRelationType.

Parameters:

recipientRelationType - RecipientRelationCodeType

getRecipientUserID

public UserIDType getRecipientUserID()

Gets the AddTransactionConfirmationItemRequestType.recipientUserID.

Returns:

UserIDType

setRecipientUserID

public void setRecipientUserID(UserIDType recipientUserID)

Sets the AddTransactionConfirmationItemRequestType.recipientUserID.

Parameters:

recipientUserID - UserIDType

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 ItemIDType getReturnedItemID()

Valid after executing the API. Gets the returned AddTransactionConfirmationItemResponseType.returnedItemID.

Returns:

ItemIDType

getReturnedStartTime

public Calendar getReturnedStartTime()

Valid after executing the API. Gets the returned AddTransactionConfirmationItemResponseType.returnedStartTime.

Returns:

Calendar