LeaveFeedback
Use this call to leave feedback about another user at the conclusion of a successful order. Both participants in the call (the requestor and the target user) must have been in a successful order within the last 60 days, one as the seller and the other as the buyer.
A user (buyer or seller) may leave just one feedback entry per order line item. LeaveFeedback provides the means for posting a single feedback entry. If an application needs to post multiple feedback entries, call LeaveFeedback repetitively, once for each feedback entry.
Usage Details
LeaveFeedback takes as input the eBay user ID for whom the feedback is being left, as well as the ItemID/TransactionID pair or OrderLineItemID, comment text, and comment type (Negative
, Neutral
, and Positive
). If a buyer is leaving Positive
feedback, they should also leave a set of Detailed Seller Ratings (DSRs) in the SellerItemRatingDetailArray.
At a minimum, the request must specify the user about whom the feedback is being left, the item ID for the associated listing, a feedback score, and a feedback comment. If the order line item associated with the feedback was a multi-quantity listing, then the call must also include the TransactionID (or just supply the OrderLineItemID) for that order line item. This is necessary to ensure the feedback is directed at the appropriate user--there may be multiple buyers for such a listing type.
Note that if the seller ends the item early and cancels all bids, prospective buyers cannot leave feedback because there is no completed order line item.
If the LeaveFeedback execution is successful, the response contains only the fields of the abstract response object, there are no call-specific return fields. An ack of Success
serves as confirmation that the feedback was successfully submitted.
Testing LeaveFeedback
You can test LeaveFeedback in the Sandbox environment. To test the call, you must have at least two test users, one to act in the capacity of an item seller and the other as a buyer.
Before you can test LeaveFeedback, an order line item must have been created. That is, an item was listed (for example, using AddItem) and successfully sold.
For auction listings, a buyer must place a bid on the item and the listing must end with the sale. You can use the Sandbox UI to place bids on the item and then end it early using EndItem. With EndItem, the seller can end the auction early without canceling the bids, and the listing ends as a successfully concluded auction.
For fixed-price listings, a TransactionID (and OrderLineItemID) is created shortly after the buyer purchases the item(s) from the listing. One order line item is created for each listing where there is a commitment to buy from a buyer. You can call LeaveFeedback for each completed order line item, either as the buyer or the seller.
Use GetItemTransactions or GetSellerTransactions to retrieve a list of the order line items for which you can leave feedback.
To verify the feedback left as a result of this testing, retrieve the feedback data for the target user with GetFeedback. The feedback retrieved should be the same (the same scores and comments) as those left during the testing.
Related Information
See:
Feedback
Seller ratings
See also the reference documentation for this call:
- GetItemsAwaitingFeedback - This call retrieves all completed order line items for which the user (buyer or seller) still needs to leave Feedback for their order partner.
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"?> <LeaveFeedbackRequest xmlns="urn:ebay:apis:eBLBaseComponents"> <!-- Call-specific Input Fields --> <CommentText> string </CommentText> <CommentType> CommentTypeCodeType </CommentType> <ItemArrivedWithinEDDType> ItemArrivedWithinEDDCodeType </ItemArrivedWithinEDDType> <ItemDeliveredWithinEDD> boolean </ItemDeliveredWithinEDD> <ItemID> ItemIDType (string) </ItemID> <OrderLineItemID> string </OrderLineItemID> <SellerItemRatingDetailArray> ItemRatingDetailArrayType <ItemRatingDetails> ItemRatingDetailsType <Rating> int </Rating> <RatingDetail> FeedbackRatingDetailCodeType </RatingDetail> </ItemRatingDetails> <!-- ... more ItemRatingDetails nodes allowed here ... --> </SellerItemRatingDetailArray> <TargetUser> UserIDType (string) </TargetUser> <TransactionID> string </TransactionID> <!-- Standard Input Fields --> <ErrorLanguage> string </ErrorLanguage> <MessageID> string </MessageID> <Version> string </Version> <WarningLevel> WarningLevelCodeType </WarningLevel> </LeaveFeedbackRequest>
Argument | Type | Occurrence | Meaning |
---|
Call-specific Input Fields [Jump to standard fields] |
CommentText | string | Required |
Textual comment that explains, clarifies, or justifies the feedback score specified in CommentType. Max length: 500. |
CommentType | CommentTypeCodeType | Required |
Score for the Feedback being left. May be Positive, Neutral, or Negative. Note: Sellers can not leave neutral or negative feedback for buyers. In addition, buyers can not leave neutral or negative feedback within 7 days from the completion of the order for active Power Sellers who have been on eBay for 12 months. Applicable values: (Not all values in CommentTypeCodeType apply to this field.) |
ItemArrivedWithinEDDType | ItemArrivedWithinEDDCodeType | Optional |
This field or the ItemDeliveredWithinEDD field should be included if it is the buyer leaving feedback for the seller. This field will inform eBay about whether or not the buyer received the order line item within the estimated delivery date, which is established once a buyer purchases or commits to buy an item.
Applicable values: (Not all values in ItemArrivedWithinEDDCodeType apply to this field.) |
ItemDeliveredWithinEDD | boolean | Conditional |
This field or the ItemArrivedWithinEDDType field should be included if it is the buyer leaving feedback for the seller. This field will inform eBay about whether or not the buyer received the order line item within the estimated delivery date window, which is established once a buyer purchases or commits to buy an item. The value of this field is set to true if the item did arrive within the estimated delivery date, or false if the item arrived past the estimated delivery date.
|
ItemID | ItemIDType (string) | Conditional | Unique identifier for an eBay listing. A listing can have multiple order line items, but only one ItemID. Unless an OrderLineItemID is specified in the LeaveFeedback request, the ItemID is required along with the TargetUser to identify an order line item existing between the caller and the TargetUser that requires feedback. A Feedback comment will be posted for this order line item. If there are multiple order line items between the two order partners that still require feedback, the TransactionID will also be required to isolate the targeted order line item. Feedback cannot be left for order line items with creation dates more than 60 days in the past. |
OrderLineItemID | string | Conditional |
OrderLineItemID is a unique identifier for an eBay order line item. If an OrderLineItemID is included in the request, the ItemID, TransactionID, and TargetUser fields are not required. Feedback cannot be left for order line items with creation dates more than 60 days in the past. Max length: 100. |
SellerItemRatingDetailArray | ItemRatingDetailArrayType | Optional |
Container for detailed seller ratings (DSRs). If a buyer is providing DSRs, they are specified in this container. Sellers have access to the number of ratings they've received, as well as to the averages of the DSRs they've received in each DSR area (i.e., to the average of ratings in the item-description area, etc.).
See Seller ratings. |
SellerItemRatingDetailArray .ItemRatingDetails |
ItemRatingDetailsType | Optional,
repeatable: [0..*] |
The ItemRatingDetails container is used by an eBay buyer to leave a Detailed Seller Rating for their order partner concerning an order line item. Detailed Seller Ratings are left concerning Communication, Item as Described, Shipping and Handling Charges, and Shipping Time. The buyer gives the seller a rating between 1 to 5 (5 being the best) in these areas. Applicable to sites that support the Detailed Seller Ratings feature. |
SellerItemRatingDetailArray .ItemRatingDetails.Rating |
int | Optional | A detailed seller rating for an order line item applied to the area in the corresponding RatingDetail field. Valid input values are numerical integers 1 though 5. |
SellerItemRatingDetailArray .ItemRatingDetails .RatingDetail |
FeedbackRatingDetailCodeType | Optional |
The area of a specific detailed seller rating for an order line item. When buyers leave an overall Feedback rating (positive, neutral, or negative) for a seller, they also can leave ratings in four areas: item as described, communication, shipping time, and charges for shipping and handling.
Applicable values: |
TargetUser | UserIDType (string) | Required | Specifies the recipient user about whom the Feedback is being left. |
TransactionID | string | Conditional |
Unique identifier for an eBay order line item. If there are multiple order line items between the two order partners that still require Feedback, the TransactionID is required along with the corresponding ItemID and TargetUser to isolate the targeted order line item. If an OrderLineItemID is included in the response to identify a specific order line item, none of the preceding fields (ItemID, TransactionID, TargetUser) are needed. Feedback cannot be left for order line items with creation dates more than 60 days in the past. 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"?> <LeaveFeedbackResponse xmlns="urn:ebay:apis:eBLBaseComponents"> <!-- Call-specific Output Fields --> <FeedbackID> string </FeedbackID> <!-- 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> </LeaveFeedbackResponse>
Return Value | Type | Occurrence | Meaning |
---|
Call-specific Output Fields [Jump to standard fields] |
FeedbackID | string | Always | The unique identifier of the Feedback entry that has been submitted by the caller. |
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.
Leaves positive feedback for a seller, including a general comment, and scores for Item Description and Shipping/Handling Charges.
Description
A buyer purchased an item from a seller and received excellent service. She wants to leave positive feedback for the order line item.
Input
As a buyer, when you leave Positive
feedback for a seller, you should also provide scores for the applicable areas. In this case, the applicable areas are Item Description and Shipping/Handling Charges. Other areas include Communication and Shipping Time.
For each of the categories, leave a rating between 1
and 5
, with 5
being the highest (best) rating.
The buyer was extremely pleased with the order line item and felt the shipping charges were very reasonable, so scored the seller a '5' in both of these areas.
XML format.
<?xml version="1.0" encoding="utf-8"?>
<LeaveFeedbackRequest xmlns="urn:ebay:apis:eBLBaseComponents">
<RequesterCredentials>
<eBayAuthToken>A*******3</eBayAuthToken>
</RequesterCredentials>
<ErrorLanguage>en_US</ErrorLanguage>
<WarningLevel>High</WarningLevel>
<ItemID>1**********6</ItemID>
<TransactionID>0</TransactionID>
<CommentText>
Great transaction! I love the product!
</CommentText>
<TargetUser>b***7</TargetUser>
<CommentType>Positive</CommentType>
<SellerItemRatingDetailArray>
<ItemRatingDetails>
<RatingDetail>ItemAsDescribed</RatingDetail>
<Rating>5</Rating>
</ItemRatingDetails>
<ItemRatingDetails>
<RatingDetail>ShippingAndHandlingCharges</RatingDetail>
<Rating>5</Rating>
</ItemRatingDetails>
</SellerItemRatingDetailArray>
</LeaveFeedbackRequest>
Output
If the Feedback submission is successful, an Ack value of 'Success' is returned, along with a unique identifier for the newly submitted Feedback entry.
XML format.
<LeaveFeedbackResponse xmlns="urn:ebay:apis:eBLBaseComponents">
<Timestamp>2019-11-06T17:24:42.250Z</Timestamp>
<Ack>Success</Ack>
<Version>1119</Version>
<Build>E1119_CORE_APIFEEDBACK_19038728_R1</Build>
<FeedbackID>1**********0</FeedbackID>
</LeaveFeedbackResponse>
Input Output Detail Controls Samples |
Change History
Change Date | Description |
---|---|
945 2015-10-15 |
|
939 2015-09-04 |
|
707 2011-02-02 |
|
705 2011-01-19 |
|
629 2009-08-05 |
|
501 2007-02-21 |
|