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.
Note: This call will be decommisioned and removed from WSDL and docs on June 5, 2023. The feature associated with this API call is no longer supported, so this call no longer has any purpose. |
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
Output Detail Controls Samples Change History |
Input
See also Samples.
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 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 | 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. |
ItemID | ItemIDType (string) | Required | This field is used to identify the eBay Motors listing using the unique identifier of the listing (ItemID). |
ListingDuration | SecondChanceOfferDurationCodeType | Required |
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.
Applicable values: |
NegotiatedPrice | AmountType (double) | Required | The amount in this field is the price that the seller is asking for to purchase the motor vehicle. |
NegotiatedPrice [ attribute currencyID ] |
CurrencyCodeType | Required |
The amount in this field is the price that the seller is asking for to purchase the motor vehicle. For a list of possible enumeration values, see CurrencyCodeType. |
RecipientPostalCode | string | Conditional | 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. |
RecipientRelationType | RecipientRelationCodeType | Required |
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.
Applicable values: |
RecipientUserID | UserIDType (string) | Required | This field is used to specify the recipient of the Transaction Confirmation Request (TCR). |
VerifyEligibilityOnly | string | Optional |
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.
|
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. Below are some examples from different countries.
|
||||||||||||||||||||||||||||||||||||||||
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., 1149). The version you specify for a call has these basic effects:
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:
|
||||||||||||||||||||||||||||||||||||||||
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 performed in the Production environment. Applicable values: High if the user wishes to receive warnings when the application passes unrecognized or deprecated elements in an API call request. Setting the WarningLevel value to High is not recommended in a production environment. Instead, it should only be used during the development/debugging stage.Low if the user does not wish to receive warnings when the application passes unrecognized or deprecated elements in an API call request. This is the default value if WarningLevel is not specified in the call request.See Warning Level. |
Input Detail Controls Samples Change History |
Output
See also Samples.
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 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 | This timestamp indicates the date and time when the Transaction Confirmation Item will no longer be available for purchase. |
ItemID | ItemIDType (string) | Conditionally | 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. |
StartTime | dateTime | Always | This timestamp indicates the date and time when the Transaction Confirmation Item became available to the recipient. |
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 the Ack field.
Applicable values: (Not all values in AckCodeType apply to this field.) Code so that your app gracefully handles any future changes to this list. |
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. |
Errors.ErrorClassification | ErrorClassificationCodeType | Conditionally |
API errors are divided between two classes: system errors and request errors.
Applicable values: Code so that your app gracefully handles any future changes to this list. |
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 Errors By Number. |
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 | 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.Value | string | Conditionally | This is the value of the request parameter noted in the ParamID attribute. So, if the ParamID value was ItemID, the value in this field would be the actual value of that ItemID. |
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: If the source of the problem is within the application (such as a missing required element), change the application before you retry the request.
See the Compatible Application Check section of the eBay Features Guide for more information. When a warning occurs, the error is returned in addition to the business data. In this case, you do not need to retry the request (as the original request was successful). However, depending on the cause or nature of the warning, you might need to contact either the end user or eBay to effect a long term solution to the problem to prevent it from reoccurring in the future. Code so that your app gracefully handles any future changes to this list. |
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 the Time Values section in the eBay Features 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 the Standard Data for All Calls section in the eBay Features Guide for information on using the response version when troubleshooting CustomCode values that appear in the response. |
Input Output Samples Change History |
Detail Controls
DetailLevel
This call does not support varying Detail Levels. You do not need to pass DetailLevel in the request.
Input Output Detail Controls Change History |
Samples
New to making API calls? Please see Making a Call.
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.
Creates a TCR with which a user can purchase an item from eBay Motors.
Description
M******************t listed a classic Rambler station wagon on eBay Motors, and Big Buyer expressed interest in the automobile. M******************t uses AddTransactionConfirmationItem to open a TCR for $12,500 USD, and send Big Buyer an option to purchase the vehicle.
Input
XML format.
<?xml version="1.0" encoding="utf-8"?>
<AddTransactionConfirmationItemRequest xmlns="urn:ebay:apis:eBLBaseComponents">
<RequesterCredentials>
<eBayAuthToken>A*******3</eBayAuthToken>
</RequesterCredentials>
<RecipientUserID>B******r</RecipientUserID>
<VerifyEligibilityOnly>false</VerifyEligibilityOnly>
<RecipientPostalCode>95125</RecipientPostalCode>
<RecipientRelationType>4</RecipientRelationType>
<NegotiatedPrice>12500</NegotiatedPrice>
<ListingDuration>Days_3</ListingDuration>
<ItemID>2**********2</ItemID>
<Comments>You are looking at one Beautiful station wagon!</Comments>
</AddTransactionConfirmationItemRequest>
Output
XML format.
<?xml version="1.0" encoding="utf-8"?>
<AddTransactionConfirmationItemResponse xmlns="urn:ebay:apis:eBLBaseComponents">
<Timestamp>2019-11-04T17:11:57.892Z</Timestamp>
<Ack>Success</Ack>
<Version>1131</Version>
<Build>E1131_CORE_API6_19105226_R1</Build>
<ItemID>2**********3</ItemID>
<StartTime>2019-11-04T00:05:22.120Z</StartTime>
<EndTime>2019-11-07T00:05:22.120Z</EndTime>
</AddTransactionConfirmationItemResponse>
Input Output Detail Controls Samples |
Change History
Change Date | Description |
---|---|
465 2006-06-14 |
|