AddTransactionConfirmationItem

Use this call to end the eBay Motors listing specified by the supplied ItemID and create a new Transaction Confirmation Request (TCR) for the item. This action enables the TCR recipient to purchase the item. Alternatively, you can use this call to see if a new TCR can be created for the specified item.

This call applies to items on the US eBay Motors site (except in the Parts and Accessories category) and can be used with items that have been listed for at least 24 hours. You can use GetCategoryFeatures to confirm if the Transaction Confirmation Request feature is defined for the category you want to use. After you create a TCR, the Item.ListingDetails.TCROriginalItemID field returned by GetItem (as well as by GetSellerList and GetBidderList) indicates the item ID of the original item listing (that is, the item ID of the listing before the TCR was created).

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.

If you use this call to create a new Transaction Confirmation Request (TCR) (rather than to verify whether or not a TCR can be created for the item), an new ItemID value for the TCR is returned in the response.

Test AddTransactionConfirmationItem by setting the VerifyEligibilityOnly field to true. This verifies that a new Transaction Confirmation Request (TCR) can be created for the specified ItemID, rather than actually creating a TCR.

See:
    Learning About Bidders
    Enabling Best Offer
    Communication Between Members

See also the reference documentation for these calls:

GetBestOffers - Retrieves Best Offers.
GetBidderList - Retrieves all items the user is currently bidding on, and the ones they have won or purchased.
GetItem - Returns item data such as title, description, price information, seller information, and so on, for the specified ItemID.
GetSellerList - Returns a list of the items posted by the authenticated user, including the related item data.

AddTransactionConfirmationItem Input

The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also Samples.

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are (or soon will be) non-operational.

The XML prototype does not include requester credentials. This is a documentation limitation only (see Standard Requester Credentials for Making Calls).

<?xml version="1.0" encoding="utf-8"?>
<AddTransactionConfirmationItemRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Input Fields -->
  <Comments> string </Comments>
  <ItemID> ItemIDType (string) </ItemID>
  <ListingDuration> SecondChanceOfferDurationCodeType </ListingDuration>
  <NegotiatedPrice currencyID="CurrencyCodeType"> AmountType (double) </NegotiatedPrice>
  <RecipientPostalCode> string </RecipientPostalCode>
  <RecipientRelationType> RecipientRelationCodeType </RecipientRelationType>
  <RecipientUserID> UserIDType (string) </RecipientUserID>
  <VerifyEligibilityOnly> string </VerifyEligibilityOnly>
  <!-- Standard Input Fields -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
</AddTransactionConfirmationItemRequest>

Argument	Type	Occurrence	Meaning

Call-specific Input Fields [Jump to standard fields]

Comments	string	Optional	Comments the seller wants to send to the recipient (bidder, best offer buyer, member with an ASQ question, or member with a postal code).
ItemID	ItemIDType (string)	Required	The ItemID of the item that the seller wants to end in order to create a Transaction Confirmation Request (TCR).
ListingDuration	SecondChanceOfferDurationCodeType	Required	Specifies the length of time the item in the Transaction Confirmation Request (TCR) will be available for purchase. Applicable values: • CustomCode (in/out) This value is reserved for internal or future use. • Days_1 (in/out) The seller specifies this value to make the Second Chance offer available to the bidder for one day. This value will affect the EndTime value returned in the AddSecondChanceItem response. • Days_3 (in/out) The seller specifies this value to make the Second Chance offer available to the bidder for three days. This value will affect the EndTime value returned in the AddSecondChanceItem response. • Days_5 (in/out) The seller specifies this value to make the Second Chance offer available to the bidder for five days. This value will affect the EndTime value returned in the AddSecondChanceItem response. • Days_7 (in/out) The seller specifies this value to make the Second Chance offer available to the bidder for seven days. This value will affect the EndTime value returned in the AddSecondChanceItem response.
NegotiatedPrice	AmountType (double)	Required	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.
NegotiatedPrice [ attribute currencyID ]	CurrencyCodeType	Required	Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType.
RecipientPostalCode	string	Optional	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.
RecipientRelationType	RecipientRelationCodeType	Required	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. Applicable values: • 1 (in) Indicates that the recipient has one or more bids on the item; the relationship is "bidder." • 2 (in) Indicates that the recipient has one or more best offers on the item; the relationship is "best offer buyer." • 3 (in) Indicates that the recipient has asked the seller a question about the item; the relationship is "a member with an ASQ question." • 4 (in) Indicates that the recipient has a postal code; the relationship is "a member with a postal code." • CustomCode (in) Reserved for internal or future use.
RecipientUserID	UserIDType (string)	Required	Specifies the user to whom the seller is offering the Transaction Confirmation Request.
VerifyEligibilityOnly	string	Optional	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.

Standard Input Fields

ErrorLanguage	string	Optional	Use ErrorLanguage to return error strings for the call in a different language from the language commonly associated with the site that the requesting user is registered with. Specify the standard RFC 3066 language identification tag (e.g., en_US). ID--- country ----- ----- de_AT Austria de_CH Switzerland de_DE Germany en_AU Australia en_CA Canada en_GB United Kingdom en_SG Singapore en_US United States es_ES Spain fr_BE Belgium (French) fr_CA Canada (French) fr_FR France it_IT Italy nl_BE Belgium (Dutch) nl_NL Netherlands zh_CN China en_IN India en_IE Ireland zh_HK Hong Kong See Tags for the Identification of Languages.
MessageID	string	Optional	Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned. Note: GetCategories is designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
Version	string	Conditional	The version number of the API code that you are programming against (e.g., 549). The version you specify for a call has these basic effects: - It indicates the version of the code lists and other data that eBay should use to process your request. - It indicates the schema version you are using. You need to use a version that is greater than or equal to the lowest supported version. For the SOAP API: If you are using the SOAP API, this field is required. Specify the version of the WSDL your application is using. For the XML API: If you are using the XML API, this field has no effect. Instead, specify the version in the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header. (If you specify Version in the body of an XML API request and it is different from the value in the HTTP header, eBay returns an informational warning that the value in the HTTP header was used instead.) See: Routing the Request (Gateway URLs) eBay Schema Versioning Strategy Lowest Supported Version
WarningLevel	WarningLevelCodeType	Optional	Controls whether or not to return warnings when the application passes unrecognized or deprecated elements in a request. An unrecognized element is one that is not defined in any supported version of the schema. Schema element names are case-sensitive, so using WarningLevel can also help you remove any potential hidden bugs within your application due to incorrect case or spelling in field names before you put your application into the Production environment. WarningLevel only validates elements; it doesn't validate XML attributes. It also doesn't control warnings related to user-entered strings or numbers, or warnings for logical errors. We recommend that you only use this during development and debugging. Do not use this in requests in your production code. Applicable values: • High (in) Return warnings when the application passes unrecognized or deprecated elements in a request. • Low (in) Do not return warnings when the application passes unrecognized or deprecated elements in a request. This is the default value if WarningLevel is not specified. See Warning Level.

AddTransactionConfirmationItem Output

The box below lists all fields that might be returned in the response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also Samples.

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are not returned (or soon will not be returned) or are not operational (or soon will be non-operational).

<?xml version="1.0" encoding="utf-8"?>
<AddTransactionConfirmationItemResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Output Fields -->
  <EndTime> dateTime </EndTime>
  <ItemID> ItemIDType (string) </ItemID>
  <StartTime> dateTime </StartTime>
  <!-- Standard Output Fields -->
  <Ack> AckCodeType </Ack>
  <Build> string </Build>
  <CorrelationID> string </CorrelationID>
  <Errors> ErrorType
    <ErrorClassification> ErrorClassificationCodeType </ErrorClassification>
    <ErrorCode> token </ErrorCode>
    <ErrorParameters ParamID="string"> ErrorParameterType
      <Value> string </Value>
    </ErrorParameters>
    <!-- ... more ErrorParameters nodes allowed here ... -->
    <LongMessage> string </LongMessage>
    <SeverityCode> SeverityCodeType </SeverityCode>
    <ShortMessage> string </ShortMessage>
  </Errors>
  <!-- ... more Errors nodes allowed here ... -->
  <HardExpirationWarning> string </HardExpirationWarning>
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
</AddTransactionConfirmationItemResponse>

Return Value	Type	Occurrence	Meaning

Call-specific Output Fields [Jump to standard fields]

EndTime	dateTime	Always	The date and time when the item in the new Transaction Confirmation Request (TCR) is no longer available for purchase.
ItemID	ItemIDType (string)	Conditionally	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.
StartTime	dateTime	Always	The date and time when the item in the new Transaction Confirmation Request (TCR) becomes available for purchase.

Standard Output Fields

Ack	AckCodeType	Always	A token representing the application-level acknowledgement code that indicates the response status (e.g., success). The AckCodeType list specifies the possible values for Ack. Applicable values: • CustomCode (out) Reserved for internal or future use. • Failure (out) Request processing failed • Success (out) Request processing succeeded • Warning (out) Request processing completed with warning information being included in the response message (Not all values in AckCodeType apply to this field.)
Build	string	Always	This refers to the specific software build that eBay used when processing the request and generating the response. This includes the version number plus additional information. eBay Developer Support may request the build information when helping you resolve technical issues.
CorrelationID	string	Conditionally	Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned. Note: GetCategories is designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
Errors	ErrorType	Conditionally, repeatable: [0..*]	A list of application-level errors (if any) that occurred when eBay processed the request. See Error Handling.
Errors.ErrorClassification	ErrorClassificationCodeType	Conditionally	API errors are divided between two classes: system errors and request errors. Applicable values: • CustomCode (out) Reserved for internal or future use. • RequestError (out) An error has occurred either as a result of a problem in the sending application or because the application's end-user has attempted to submit invalid data (or missing data). In these cases, do not retry the request. The problem must be corrected before the request can be made again. If the problem is due to something in the application (such as a missing required field), the application must be changed. If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the application or data is resolved, resend the request to eBay with the corrected data. • SystemError (out) Indicates that an error has occurred on the eBay system side, such as a database or server down. An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.
Errors.ErrorCode	token	Conditionally	A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms. See the "Errors by Number" document.
Errors.ErrorParameters	ErrorParameterType	Conditionally, repeatable: [0..*]	This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned.
Errors.ErrorParameters [ attribute ParamID ]	string	Conditionally	The index of the parameter in the list of parameter types returned within the error type.
Errors.ErrorParameters.Value	string	Conditionally	The value of the variable (e.g., the attribute set ID)
Errors.LongMessage	string	Conditionally	A more detailed description of the condition that raised the error.
Errors.SeverityCode	SeverityCodeType	Conditionally	Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user. Applicable values: • CustomCode (out) Reserved for internal or future use • Error (out) Application-level error • Warning (out) Warning or informational error
Errors.ShortMessage	string	Conditionally	A brief description of the condition that raised the error.
HardExpirationWarning	string	Conditionally	Expiration date of the user's authentication token. Only returned within the 7-day period prior to a token's expiration. To ensure that user authentication tokens are secure and to help avoid a user's token being compromised, tokens have a limited life span. A token is only valid for a period of time (set by eBay). After this amount of time has passed, the token expires and must be replaced with a new token.
Timestamp	dateTime	Always	This value represents the date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See Time Values in the eBay Web Services guide for information about this time format and converting to and from the GMT time zone. Note: GetCategories and other Trading API calls are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, this time value reflects the time the cached response was created. Thus, this value is not necessarily when the request was processed. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, this time value does reflect when the request was processed.
Version	string	Always	The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. See "Standard Data for All Calls" in the eBay Web Services Guide for information on using the response version when troubleshooting "CustomCode" values that appear in the response.

AddTransactionConfirmationItem Detail Controls

Detail Control: DetailLevel

This call does not support varying Detail Levels. You do not need to pass DetailLevel in the request.

AddTransactionConfirmationItem Samples

New to making API calls? Please see Routing the Request.

Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.

Sample: Basic Call

Creates a TCR with which a user can purchase an item from eBay Motors.

Description

Mega Online Merchant listed a classic Rambler station wagon on eBay Motors, and Big Buyer expressed interest in the automobile. Mega Online Merchant uses AddTransactionConfirmationItem to open a TCR for $12,500 USD, and send Big Buyer an option to purchase the vehicle.

Input

XML format (HTTP POST). Also available is the .txt version of this XML.

<?xml version="1.0" encoding="utf-8"?> 
<AddTransactionConfirmationItemRequest xmlns="urn:ebay:apis:eBLBaseComponents"> 
  <RequesterCredentials> 
    <eBayAuthToken>ABC...123</eBayAuthToken> 
  </RequesterCredentials> 
  <RecipientUserID>BigBuyer</RecipientUserID> 
  <VerifyEligibilityOnly>false</VerifyEligibilityOnly> 
  <RecipientPostalCode>95125</RecipientPostalCode> 
  <RecipientRelationType>4</RecipientRelationType> 
  <NegotiatedPrice>12500</NegotiatedPrice> 
  <ListingDuration>Days_3</ListingDuration> 
  <ItemID>24009006222</ItemID> 
  <Comments>You are looking at one Beautiful station wagon!</Comments> 
</AddTransactionConfirmationItemRequest>

Output

XML format. Also available is the .txt version of this XML.

<?xml version="1.0" encoding="utf-8"?> 
<AddTransactionConfirmationItemResponse xmlns="urn:ebay:apis:eBLBaseComponents"> 
  <Timestamp>2006-07-11T00:05:21.120Z</Timestamp> 
  <Ack>Success</Ack> 
  <Version>465</Version> 
  <Build>20050123212033</Build> 
  <ItemID>289900062333</ItemID> 
  <StartTime>2006-07-11T00:05:22.120Z</StartTime> 
  <EndTime>2006-07-14T00:05:22.120Z</EndTime> 
</AddTransactionConfirmationItemResponse>

AddTransactionConfirmationItem Change History

Version	Description
465 2006-06-14	(added) New call.

User-Contributed Notes

eBay Trading API Call Reference Version 823