RespondToFeedback
Use this call to reply to feedback that has been left for a user, or to post a follow-up comment to a feedback comment a user has left for someone else. Feedback replies or follow-ups are shown on the user's feedback page on the site, and can be retrieved by using GetFeedback.
Users typically only respond to neutral or negative feedback, so your application could encourage users to only respond to those kinds of feedback, thus helping to ensure that you don't make this call more than is necessary.
Note that you cannot use this call for mutual feedback withdrawal, even though this functionality is available on the eBay site.
Usage Details
RespondToFeedback takes input values for ResponseText, ResponseType, and TargetUserID. You must also supply a combination of FeedbackID, ItemID, and TrasactionID values in order to correctly identify the order line item and user to which your feedback applies.
Testing RespondToFeedback
You can test RespondToFeedback in the Sandbox environment. To test the call, the user must have received feedback to which they can respond, or they must have left feedback to which they can post a follow-up reply.
Before you can test RespondToFeedback, an order line item must have been created. That is, an item was listed (for example, using AddItem) and successfully sold.
- Create two test users, a seller and a buyer.
- List an item with your test seller and purchase it using your test buyer.
- Have the test buyer leave feedback for the seller.
- Use RespondToFeedback to post a reply on behalf of the seller or a follow-up on behalf of the buyer.
Related Information
See also the reference documentation for this call:
- GetFeedback - Retrieves one, many, or all Feedback records for a specific eBay user.
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"?> <RespondToFeedbackRequest xmlns="urn:ebay:apis:eBLBaseComponents"> <!-- Call-specific Input Fields --> <FeedbackID> string </FeedbackID> <ItemID> ItemIDType (string) </ItemID> <OrderLineItemID> string </OrderLineItemID> <ResponseText> string </ResponseText> <ResponseType> FeedbackResponseCodeType </ResponseType> <TargetUserID> UserIDType (string) </TargetUserID> <TransactionID> string </TransactionID> <!-- Standard Input Fields --> <ErrorLanguage> string </ErrorLanguage> <MessageID> string </MessageID> <Version> string </Version> <WarningLevel> WarningLevelCodeType </WarningLevel> </RespondToFeedbackRequest>
Argument | Type | Occurrence | Meaning |
---|
Call-specific Input Fields [Jump to standard fields] |
FeedbackID | string | Conditional | A unique identifier for a Feedback record. Buying and selling partners leave feedback for one another after the completion of an order. Feedback is left at the order line item level, so a Feedback comment for each order line item in a Combined Payment order is expected from the buyer and seller. A unique FeedbackID is created whenever a buyer leaves feedback for a seller, and vice versa. A FeedbackID is created by eBay when feedback is left through the eBay site, or through the LeaveFeedback call. FeedbackIDs can be retrieved with the GetFeedback call. In the RespondToFeedback call, FeedbackID can be used as an input filter to respond to a specific Feedback comment. Since Feedback is always linked to a unique order line item, an ItemID/TransactionID pair or an OrderLineItemID can also be used to respond to a Feedback comment. |
ItemID | ItemIDType (string) | Conditional | Unique identifier for the eBay listing to which the user will be responding to Feedback. A listing can have multiple order line items, but only one ItemID value. An ItemID can be paired up with a corresponding TransactionID and used as an input filter to respond to a Feedback comment in the RespondToFeedback call. Unless the specific Feedback record is identified by a FeedbackID or an OrderLineItemID in the request, an ItemID/TransactionID pair is required. |
OrderLineItemID | string | Conditional |
OrderLineItemID is a unique identifier for an eBay order line item. Since Feedback is always linked to a unique order line item, an OrderLineItemID can be used to respond to a Feedback comment. Unless an ItemID/TransactionID pair or a FeedbackID is used to identify a Feedback record, the OrderLineItemID must be specified. |
ResponseText | string | Required |
Textual comment that the user who is subject of feedback may leave in response or rebuttal to the Feedback comment. Alternatively, when the ResponseType is FollowUp, this value contains the text of the follow-up comment. Max length: 500. |
ResponseType | FeedbackResponseCodeType | Required |
Specifies whether the response is a reply or a follow-up to a Feedback comment left by the user identified in the TargetUserID field.
Applicable values: |
TargetUserID | UserIDType (string) | Required | The eBay user ID of the caller's order partner. The caller is either replyting to or following up on this user's Feedback comment. |
TransactionID | string | Optional |
Unique identifier for an eBay order line item. A TransactionID can be paired up with its corresponding ItemID and used as an input filter to respond to a Feedback comment in the RespondToFeedback call. Unless the specific Feedback record is identified by a FeedbackID or an OrderLineItemID in the request, an ItemID/TransactionID pair is required. The TransactionID value for auction listings is always 0 since there can be only one winning bidder/one sale for an auction listing. Note: Beginning in July 2024, non-zero transaction IDs will start being returned for auction listings. If necessary, update code to handle non-zero transaction IDs for auction transactions before this time. |
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"?> <RespondToFeedbackResponse xmlns="urn:ebay:apis:eBLBaseComponents"> <!-- (No call-specific Output fields) --> <!-- 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> </RespondToFeedbackResponse>
Return Value | Type | Occurrence | Meaning |
---|
(No call-specific fields) |
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 Error handling section of the Making a Trading API call 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.
Replies to feedback left by the buyer.
Description
The seller saw that b************r has left positive feedback for the book she bought and wants to thank her.
You need to supply an ItemID, a TargetUserID, and a TransactionID. Set TransactionID to 0
if there is no specific TransactionID.
Input
XML format.
<?xml version="1.0" encoding="utf-8"?>
<RespondToFeedbackRequest xmlns="urn:ebay:apis:eBLBaseComponents">
<RequesterCredentials>
<eBayAuthToken>A*******3</eBayAuthToken>
</RequesterCredentials>
<TargetUserID>b************r</TargetUserID>
<ItemID>1**********4</ItemID>
<TransactionID>0</TransactionID>
<ResponseType>Reply</ResponseType>
<ResponseText>Thanks for the positive feedback, we appreciate that!</ResponseText>
</RespondToFeedbackRequest>
Output
XML format.
<RespondToFeedbackResponse xmlns="urn:ebay:apis:eBLBaseComponents">
<Timestamp>2019-11-06T18:31:35.892Z</Timestamp>
<Ack>Success</Ack>
<Version>1119</Version>
<Build>E1119_CORE_APIFEEDBACK_19038728_R1</Build>
</RespondToFeedbackResponse>
Input Output Detail Controls Samples |
Change History
Change Date | Description |
---|---|
705 2011-01-19 |
|
693 2010-10-27 |
|