GetFeedback
Use this call to retrieve the accumulated feedback left for a specified user, or the summary feedback data for a specific item listing or order line item.
Usage Details
GetFeedback takes the following values as input filters: UserID, Item ID, Transaction ID, or OrderLineItemID. See the API Reference Input table for more information on these fields. If no input filters are specified, the call returns the aggregate feedback score for the requesting user.
If you specify a UserID, GetFeedback returns the aggregate feedback score for the specified user and the summary feedback data used to calculate that score. If you are retrieving feedback data for a User ID, set DetailLevel to ReturnAll
to return the summary data plus the details (the score and associated comment) of each feedback record.
Be default, the call returns all comment types. However, you can use the CommentType input property to specify the type of feedback comments you want to view: positive
, negative
, or neutral
. If desired, include two comment types to exclude the third comment type from your results.
Use the Pagination.EntriesPerPage and Pagination.PageNumber input properties to paginate the results of User ID feedback data. Because pagination works only with detailed feedback entries (and not the summary feedback data), you must set DetailLevel to ReturnAll
in order to paginate the result set.
The EntriesPerPage property establishes the maximum number of feedback detail entries returned per call. This value can be set to only 25
(the default), 50
, 100
, or 200
. If you use pagination, the summary data is returned after the last feedback detail entry.
If you are requesting information based on an Item ID, the call returns a maximum number of 100 feedback records, any pagination values are ignored.
Note that you can use feedback-related platform notifications--Feedback, FeedbackLeft, and FeedbackReceived--to update feedback records without making an API call.
Working with the Response
Feedback records change infrequently and are returned with the newest records listed first. If you are developing a seller application that verifies if feedback has been left for a order line item, your application should retrieve pages only until the page contains a feedback record that was previously retrieved.
Testing GetFeedback
You can test GetFeedback in the Sandbox environment. For best results:
- Use a minimum of three test users. This allows for one test user to be the one whose feedback is returned and the others serve as participants in successfully ended listings. Have different test users leave multiple feedback scores for the target user.
- Test GetFeedback on a new test user who does not yet have any feedback. Also test for returning just summary feedback data as well as returning feedback details.
- Test GetFeedback on a test user or item with enough feedback entries to paginate the feedback detail data. For example, if you have a user with 20 feedback records, use pagination to return 10 feedback records per call, and retrieve all records. Succeeding on this test ensures that the application is able to accommodate retrieving voluminous feedback with multiple sequential calls.
Related Information
See Second change offers.
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"?> <GetFeedbackRequest xmlns="urn:ebay:apis:eBLBaseComponents"> <!-- Call-specific Input Fields --> <CommentType> CommentTypeCodeType </CommentType> <!-- ... more CommentType values allowed here ... --> <FeedbackID> string </FeedbackID> <FeedbackType> FeedbackTypeCodeType </FeedbackType> <ItemID> ItemIDType (string) </ItemID> <OrderLineItemID> string </OrderLineItemID> <Pagination> PaginationType <EntriesPerPage> int </EntriesPerPage> <PageNumber> int </PageNumber> </Pagination> <TransactionID> string </TransactionID> <UserID> UserIDType (string) </UserID> <!-- Standard Input Fields --> <DetailLevel> DetailLevelCodeType </DetailLevel> <!-- ... more DetailLevel values allowed here ... --> <ErrorLanguage> string </ErrorLanguage> <MessageID> string </MessageID> <OutputSelector> string </OutputSelector> <!-- ... more OutputSelector values allowed here ... --> <Version> string </Version> <WarningLevel> WarningLevelCodeType </WarningLevel> </GetFeedbackRequest>
Argument | Type | Occurrence | Meaning |
---|
Call-specific Input Fields [Jump to standard fields] |
CommentType | CommentTypeCodeType | Optional,
repeatable: [0..*] |
This field is used to retrieve Feedback records of a specific type (Positive, Negative, or Neutral) in FeedbackDetailArray. You can include one or two CommentType fields in the request. If no CommentType value is specified, Feedback records of all types are returned.
Applicable values: See CommentType. |
FeedbackID | string | Optional | The unique identifier of a Feedback record. This field is used if the user wants to retrieve a specific Feedback record. If FeedbackID is specified in the call request, all other input fields are ignored. |
FeedbackType | FeedbackTypeCodeType | Optional |
This field is used to restrict retrieved Feedback records to those that the user left for other buyers, Feedback records received as a seller, Feedback records received as a buyer, or Feedback records received as a buyer and seller. The default value is FeedbackReceived, so if the FeedbackType field is omitted in the request, all Feedback records received by the user as a buyer and seller are returned in the response. "Feedback Left" data will not be returned in the call response. Default: FeedbackReceived. Applicable values: |
ItemID | ItemIDType (string) | Optional | Unique identifier for an eBay listing. A listing can have multiple order line items, but only one ItemID. If ItemID is specified in the GetFeedback request, the returned Feedback record(s) are restricted to the specified ItemID. The maximum number of Feedback records that can be returned is 100. |
OrderLineItemID | string | Optional | OrderLineItemID is a unique identifier for an eBay order line item. An OrderLineItemID can be used as an input filter in the GetFeedback request. If an OrderLineItemID value is used to retrieve a feedback record on a specific order line item, the FeedbackType and Pagination fields (if included) are ignored. |
Pagination | PaginationType | Optional |
Controls the pagination of the result set. Child elements, EntriesPerPage and PageNumber, specify the maximum number of individual feedback records to return per call and which page of data to return. Only applicable if DetailLevel is set to ReturnAll and the call is returning feedback for a UserID. Feedback summary data is not paginated, but when pagination is used, it is returned after the last feedback detail entry. Accepted values for Pagination.EntriesPerPage for GetFeedback is 25 (the default), 50, 100, and 200. If you specify a value of zero, or a value greater than 200, the call fails with an error. If you specify a value between one and twenty-four, the value is rounded up to 25. Values between 26 and 199 that are not one of the accepted values are rounded down to the nearest accepted value. |
Pagination.EntriesPerPage | int | Optional |
This integer value is used to specify the maximum number of entries to return in a single "page" of data. This value, along with the number of entries that match the input criteria, will determine the total pages (see PaginationResult.TotalNumberOfPages) in the result set. The maximum and default values are not the same for all calls. For most Trading API calls, the maximum value is 200 and the default value is 25 entries per page. |
Pagination.PageNumber | int | Optional |
Specifies the number of the page of data to return in the current call. Default is 1 for most calls. For some calls, the default is 0. Specify a positive value equal to or lower than the number of pages available (which you determine by examining the results of your initial request). See the documentation for the individual calls to determine the correct default value. Min: 1. Default: 1. |
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 in the GetFeedback request. If an ItemID/TransactionID pair or an OrderLineItemID value is used to retrieve a feedback record on a specific order line item, the FeedbackType and Pagination fields (if included) are ignored. 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. |
UserID | UserIDType (string) | Optional | The user's eBay User ID is specified in this field. If this field is used, all retrieved Feedback data will be for this eBay user. Specifies the user whose feedback data is to be returned. If this field is omitted in the call request, all retrieved Feedback records will be for the eBay user making the call. |
Standard Input Fields |
DetailLevel | DetailLevelCodeType | Optional,
repeatable: [0..*] |
Detail levels are instructions that define standard subsets of data to return for particular data components (e.g., each Item, Transaction, or User) within the response payload. For example, a particular detail level might cause the response to include buyer-related data in every result (e.g., for every Item), but no seller-related data. Specifying a detail level is like using a predefined attribute list in the SELECT clause of an SQL query. Use the DetailLevel element to specify the required detail level that the client application needs pertaining to the data components that are applicable to the request. The DetailLevelCodeType defines the global list of available detail levels for all request types. Most request types support certain detail levels or none at all. If you pass a detail level that exists in the schema but that isn't valid for a particular request, eBay ignores it and processes the request without it. For each request type, see the detail level tables in the Input/Output Reference to determine which detail levels are applicable and which elements are returned for each applicable detail level. Note that DetailLevel is required input for GetMyMessages. With GetSellerList and other calls that retrieve large data sets, please avoid using ReturnAll when possible. For example, if you use GetSellerList, use GranularityLevel instead, or use GetSellerEvents. If you do use 'ReturnAll' with GetSellerList, use a small Pagination.EntriesPerPage value and a narrow EndTimeFrom/EndTimeTo date range for better performance. Applicable values: (Not all values in DetailLevelCodeType apply to this field.) |
||||||||||||||||||||||||||||||||||||||||
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. |
||||||||||||||||||||||||||||||||||||||||
OutputSelector | string | Optional,
repeatable: [0..*] |
You can use the OutputSelector field to restrict the data returned by a call. This field can make the call response easier to manage, especially when a large payload is returned. If you use the OutputSelector field, the output data will only include the field(s) you specified in the request, as well as all of its child fields (if a field is a container) and its parent fields (if any). Note that it is possible that a field included through an OutputSelector field may still not be returned if it is not applicable, or if it is not found based on other criteria set up in the request payload. For example, if you are using GetItem and you only want to retrieve the URL of the View Item page (emitted in ViewItemURL field) and the item's Buy It Now price (emitted in BuyItNowPrice field), you would include two separate OutputSelector fields and set the value for each one as ViewItemURL and BuyItNowPrice as in the following example: If the following output selectors are used: See OutputSelector. |
||||||||||||||||||||||||||||||||||||||||
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"?> <GetFeedbackResponse xmlns="urn:ebay:apis:eBLBaseComponents"> <!-- Call-specific Output Fields --> <EntriesPerPage> int </EntriesPerPage> <FeedbackDetailArray> FeedbackDetailArrayType <FeedbackDetail> FeedbackDetailType <CommentingUser> UserIDType (string) </CommentingUser> <CommentingUserScore> int </CommentingUserScore> <CommentReplaced> boolean </CommentReplaced> <CommentText> string </CommentText> <CommentTime> dateTime </CommentTime> <CommentType> CommentTypeCodeType </CommentType> <Countable> boolean </Countable> <FeedbackID> string </FeedbackID> <FeedbackRatingStar> FeedbackRatingStarCodeType </FeedbackRatingStar> <FeedbackResponse> string </FeedbackResponse> <FeedbackRevised> boolean </FeedbackRevised> <Followup> string </Followup> <FollowUpReplaced> boolean </FollowUpReplaced> <ItemID> ItemIDType (string) </ItemID> <ItemPrice currencyID="CurrencyCodeType"> AmountType (double) </ItemPrice> <ItemTitle> string </ItemTitle> <OrderLineItemID> string </OrderLineItemID> <ResponseReplaced> boolean </ResponseReplaced> <Role> TradingRoleCodeType </Role> <TransactionID> string </TransactionID> </FeedbackDetail> <!-- ... more FeedbackDetail nodes allowed here ... --> </FeedbackDetailArray> <FeedbackDetailItemTotal> int </FeedbackDetailItemTotal> <FeedbackScore> int </FeedbackScore> <FeedbackSummary> FeedbackSummaryType <BidRetractionFeedbackPeriodArray> FeedbackPeriodArrayType <FeedbackPeriod> FeedbackPeriodType <Count> int </Count> <PeriodInDays> int </PeriodInDays> </FeedbackPeriod> <!-- ... more FeedbackPeriod nodes allowed here ... --> </BidRetractionFeedbackPeriodArray> <BuyerRoleMetrics> BuyerRoleMetricsType <FeedbackLeftPercent> float </FeedbackLeftPercent> <NegativeFeedbackLeftCount> int </NegativeFeedbackLeftCount> <NeutralFeedbackLeftCount> int </NeutralFeedbackLeftCount> <PositiveFeedbackLeftCount> int </PositiveFeedbackLeftCount> </BuyerRoleMetrics> <NegativeFeedbackPeriodArray> FeedbackPeriodArrayType <FeedbackPeriod> FeedbackPeriodType <Count> int </Count> <PeriodInDays> int </PeriodInDays> </FeedbackPeriod> <!-- ... more FeedbackPeriod nodes allowed here ... --> </NegativeFeedbackPeriodArray> <NeutralCommentCountFromSuspendedUsers> int </NeutralCommentCountFromSuspendedUsers> <NeutralFeedbackPeriodArray> FeedbackPeriodArrayType <FeedbackPeriod> FeedbackPeriodType <Count> int </Count> <PeriodInDays> int </PeriodInDays> </FeedbackPeriod> <!-- ... more FeedbackPeriod nodes allowed here ... --> </NeutralFeedbackPeriodArray> <PositiveFeedbackPeriodArray> FeedbackPeriodArrayType <FeedbackPeriod> FeedbackPeriodType <Count> int </Count> <PeriodInDays> int </PeriodInDays> </FeedbackPeriod> <!-- ... more FeedbackPeriod nodes allowed here ... --> </PositiveFeedbackPeriodArray> <SellerRatingSummaryArray> SellerRatingSummaryArrayType <AverageRatingSummary> AverageRatingSummaryType <AverageRatingDetails> AverageRatingDetailsType <Rating> double </Rating> <RatingCount> int </RatingCount> <RatingDetail> FeedbackRatingDetailCodeType </RatingDetail> </AverageRatingDetails> <!-- ... more AverageRatingDetails nodes allowed here ... --> <FeedbackSummaryPeriod> FeedbackSummaryPeriodCodeType </FeedbackSummaryPeriod> </AverageRatingSummary> <!-- ... more AverageRatingSummary nodes allowed here ... --> </SellerRatingSummaryArray> <SellerRoleMetrics> SellerRoleMetricsType <CrossBorderTransactionCount> int </CrossBorderTransactionCount> <CrossBorderTransactionPercent> float </CrossBorderTransactionPercent> <FeedbackLeftPercent> float </FeedbackLeftPercent> <NegativeFeedbackLeftCount> int </NegativeFeedbackLeftCount> <NeutralFeedbackLeftCount> int </NeutralFeedbackLeftCount> <PositiveFeedbackLeftCount> int </PositiveFeedbackLeftCount> <RepeatBuyerCount> int </RepeatBuyerCount> <RepeatBuyerPercent> float </RepeatBuyerPercent> <TransactionPercent> float </TransactionPercent> <UniqueBuyerCount> int </UniqueBuyerCount> </SellerRoleMetrics> <TotalFeedbackPeriodArray> FeedbackPeriodArrayType <FeedbackPeriod> FeedbackPeriodType <Count> int </Count> <PeriodInDays> int </PeriodInDays> </FeedbackPeriod> <!-- ... more FeedbackPeriod nodes allowed here ... --> </TotalFeedbackPeriodArray> <UniqueNegativeFeedbackCount> int </UniqueNegativeFeedbackCount> <UniqueNeutralFeedbackCount> int </UniqueNeutralFeedbackCount> <UniquePositiveFeedbackCount> int </UniquePositiveFeedbackCount> </FeedbackSummary> <PageNumber> int </PageNumber> <PaginationResult> PaginationResultType <TotalNumberOfEntries> int </TotalNumberOfEntries> <TotalNumberOfPages> int </TotalNumberOfPages> </PaginationResult> <!-- 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> </GetFeedbackResponse>
Return Value | Type | Occurrence | Meaning |
---|
Call-specific Output Fields [Jump to standard fields] |
EntriesPerPage | int | Always |
Indicates the number of Feedback records that are set to be returned per page of data (i.e., per call). The EntriesPerPage value defaults to 25 if the Pagination.EntriesPerPage field is not set in the request. This field is always returned even if the response is not showing any Feedback entries. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
FeedbackDetailArray | FeedbackDetailArrayType | Conditionally |
Contains the individual Feedback records for the user or order line item specified in the request. There is one FeedbackDetail container returned for each Feedback record. Only populated with data when a detail level of ReturnAll is specified in the request. Not returned if you specify a FeedbackID in the request.
DetailLevel: ReturnAll. |
FeedbackDetailArray .FeedbackDetail |
FeedbackDetailType | Conditionally,
repeatable: [0..*] |
This container consists of detailed information for a Feedback entry on a specific order line item. For Feedback entries that were left for the buyer by the seller, some of the fields in this container will not be returned to users who were not involved in the transaction as either the buyer or seller.
DetailLevel: ReturnAll. |
FeedbackDetailArray .FeedbackDetail.CommentingUser |
UserIDType (string) | Conditionally |
The eBay User ID of the user who left the Feedback entry. Note: This field is returned, but masked to users who are not either the buyer or seller of the order line item. DetailLevel: ReturnAll. |
FeedbackDetailArray .FeedbackDetail .CommentingUserScore |
int | Conditionally |
This integer value is the Feedback score of the user indicated in the CommentingUser field.
DetailLevel: ReturnAll. |
FeedbackDetailArray .FeedbackDetail .CommentReplaced |
boolean | Conditionally |
This boolean value indicates whether or not eBay replaced the Feedback comment with a message that the Feedback comment was removed.
DetailLevel: ReturnAll. |
FeedbackDetailArray .FeedbackDetail.CommentText |
string | Conditionally |
This free-form text is the actual comment that the commenting user left for their order partner. The Feedback comment's purpose is to explain, clarify, or justify the Feedback rating specified in the CommentType field. The comment is returned as text in the language that the comment was originally left in. This comment will still be displayed even if a submitted Feedback entry is withdrawn. Max length: 500. DetailLevel: ReturnAll. |
FeedbackDetailArray .FeedbackDetail.CommentTime |
dateTime | Conditionally |
This timestamp (in GMT) indicates the date/time that the Feedback entry was submitted to eBay.
DetailLevel: ReturnAll. |
FeedbackDetailArray .FeedbackDetail.CommentType |
CommentTypeCodeType | Conditionally |
This value indicates the rating of the Feedback left by the user identified in the CommentingUser field. A Positive rating increases a user's Feedback score, a Negative rating decreases a user's Feedback score, and a Neutral rating does not affect a user's Feedback score. Sellers cannot leave Neutral or Negative ratings for buyers. Applicable values: See CommentType. Code so that your app gracefully handles any future changes to this list. DetailLevel: ReturnAll. |
FeedbackDetailArray .FeedbackDetail.Countable |
boolean | Conditionally |
This boolean value indicates whether or not the Feedback entry will affect the user's Feedback score. Only Feedback left by verified users can count toward the aggregate score of another user. If a unverified user leaves a Feedback entry, then later becomes verified, that Feedback entry will still have no affect on the recipient user's Feedback score. Or, if a user is verified and at some later date changes to unverified status, the Feedback entry left while the user was verified remains in effect. Default: true. DetailLevel: ReturnAll. |
FeedbackDetailArray .FeedbackDetail.FeedbackID |
string | Conditionally |
Unique identifier for the Feedback entry.
DetailLevel: ReturnAll. |
FeedbackDetailArray .FeedbackDetail .FeedbackRatingStar |
FeedbackRatingStarCodeType | Conditionally |
This enumeration value is the Feedback Rating Star of the user indicated in the CommentingUser field. See FeedbackRatingStarCodeType for the full list of Feedback Rating Stars, and the Feedback score ranges associated with those stars.
Applicable values: See FeedbackRatingStar. Code so that your app gracefully handles any future changes to this list. DetailLevel: ReturnAll. |
FeedbackDetailArray .FeedbackDetail .FeedbackResponse |
string | Conditionally |
This free-form text is the comment that the recipient of the Feedback may leave in response or rebuttal to the Feedback. Responses to Feedback comments cannot be submitted or edited via the API. Max length: 500. DetailLevel: ReturnAll. |
FeedbackDetailArray .FeedbackDetail .FeedbackRevised |
boolean | Conditionally |
This flag indicates whether or not a Feedback entry was revised (rating was changed).
DetailLevel: ReturnAll. |
FeedbackDetailArray .FeedbackDetail.Followup |
string | Conditionally |
This free-form text is the explanation that a user can give to a response. Follow-ups to Feedback comments cannot be submitted or edited via the API. Max length: 500. DetailLevel: ReturnAll. |
FeedbackDetailArray .FeedbackDetail .FollowUpReplaced |
boolean | Conditionally |
This boolean value indicates whether or not eBay replaced the follow-up to the Feedback comment with a message that the follow-up to the Feedback comment was removed.
DetailLevel: ReturnAll. |
FeedbackDetailArray .FeedbackDetail.ItemID |
ItemIDType (string) | Conditionally |
The unique identifier of the eBay listing associated with the Feedback entry. Note: For Feedback entries that were submitted less than five years ago, this field is returned to users who are not the buyer or seller of the order line item, but a dummy value such as '111111111' will be displayed. For Feedback entries that were submitted more than five years ago, this field will not be returned at all to users who do not have a relationship (as a buyer or seller) to the Feedback entry. DetailLevel: ReturnAll. |
FeedbackDetailArray .FeedbackDetail.ItemPrice |
AmountType (double) | Conditionally |
The purchase price for the item that was associated with the Feedback entry. This value can be returned as part of the Detailed Seller Ratings feature. Not returned if a listing ended more than 90 days ago. For Feedback entries that were left for the buyer by the seller, an ItemPrice value will not be returned to a user that was not involved in the transaction as either the buyer or seller.
DetailLevel: ReturnAll. See Seller ratings. |
FeedbackDetailArray .FeedbackDetail.ItemPrice [ attribute currencyID ] |
CurrencyCodeType | Always |
The purchase price for the item that was associated with the Feedback entry. This value can be returned as part of the Detailed Seller Ratings feature. Not returned if a listing ended more than 90 days ago. For Feedback entries that were left for the buyer by the seller, an ItemPrice value will not be returned to a user that was not involved in the transaction as either the buyer or seller. For a list of possible enumeration values, see CurrencyCodeType. |
FeedbackDetailArray .FeedbackDetail.ItemTitle |
string | Conditionally |
The title of the item listing for which Feedback was provided. The title is returned as CDATA. This value can be returned as part of the Detailed Seller Ratings feature. Not returned if a listing ended more than 90 days ago. For Feedback entries that were left for the buyer by the seller, an ItemTitle value will not be returned to a user that was not involved in the transaction as either the buyer or seller. Max length: 80. DetailLevel: ReturnAll. See Seller ratings. |
FeedbackDetailArray .FeedbackDetail .OrderLineItemID |
string | Conditionally |
The unique identifier for an eBay order line item. For Feedback entries that were left for the buyer by the seller, an OrderLineItemID value will not be returned to a user that was not involved in the transaction as either the buyer or seller. Note: For Feedback entries that were submitted less than five years ago, this field is returned to users who are not the buyer or seller of the order line item, but a dummy value such as '11111111-0' will be displayed. For Feedback entries that were submitted more than five years ago, this field will not be returned at all to users who do not have a relationship (as a buyer or seller) to the Feedback entry. DetailLevel: ReturnAll. |
FeedbackDetailArray .FeedbackDetail .ResponseReplaced |
boolean | Conditionally |
This boolean value indicates whether or not eBay replaced the response to the Feedback comment with a message that the response to the Feedback comment was removed.
DetailLevel: ReturnAll. |
FeedbackDetailArray .FeedbackDetail.Role |
TradingRoleCodeType | Conditionally |
Indicates whether the recipient of the Feedback entry is the buyer or the seller for the corresponding order line item.
Applicable values: Code so that your app gracefully handles any future changes to this list. DetailLevel: ReturnAll. |
FeedbackDetailArray .FeedbackDetail.TransactionID |
string | Conditionally |
Unique identifier for an eBay order line item for which the Feedback entry was left. This field is not returned if the Feedback entry was left for an auction listing, since all auction listings have a TransactionID value of 0. 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. Note: For Feedback entries that were submitted less than five years ago, this field is returned to users who are not the buyer or seller of the order line item, but a dummy value such as '111111111' will be displayed. For Feedback entries that were submitted more than five years ago, this field will not be returned at all to users who do not have a relationship (as a buyer or seller) to the Feedback entry. DetailLevel: ReturnAll. |
FeedbackDetailItemTotal | int | Conditionally |
Indicates the total number of Feedback records returned in the the response. Only applicable if Feedback details are returned.
DetailLevel: ReturnAll. |
FeedbackScore | int | Always |
Indicates the total Feedback score for the user.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
FeedbackSummary | FeedbackSummaryType | Conditionally |
Summary Feedback data for the user. Contains counts of positive, neutral, and negative Feedback for pre-defined time periods. Only applicable if Feedback details are returned.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
FeedbackSummary .BidRetractionFeedbackPeriodArray |
FeedbackPeriodArrayType | Conditionally |
Bid retractions count, for multiple predefined time periods preceding the call. Returned if no detail level is specified.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
FeedbackSummary .BidRetractionFeedbackPeriodArray .FeedbackPeriod |
FeedbackPeriodType | Conditionally,
repeatable: [0..*] |
Contains one feedback statistic giving length of the period being reported (e.g. last 7 days prior to the call), and total number of feedback entries (of the type given by the container, e.g. positive feedback) submitted during the indicated period. Returned if no detail level is specified.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
FeedbackSummary .BidRetractionFeedbackPeriodArray .FeedbackPeriod.Count |
int | Conditionally |
This integer value indicates the total number of Feedback entries that occurred within the time period specified in the PeriodInDays field. This field is always returned with the FeedbackPeriod container.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
FeedbackSummary .BidRetractionFeedbackPeriodArray .FeedbackPeriod.PeriodInDays |
int | Conditionally |
This integer value indicates the total number of days in the time period for the Feedback count. Typically, the returned time periods are 30 days, 180 days, and 365 days. This field is always returned with the FeedbackPeriod container.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
FeedbackSummary .BuyerRoleMetrics |
BuyerRoleMetricsType | Conditionally |
Container for information about 1 year feedback metric as buyer.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
FeedbackSummary .BuyerRoleMetrics .FeedbackLeftPercent |
float | Conditionally |
This float value indicates the percentage of time that the eBay user, acting in the buying role, has left feedback for their order partner (seller) during the last one-year period, counting back from the present date.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
FeedbackSummary .BuyerRoleMetrics .NegativeFeedbackLeftCount |
int | Conditionally |
This integer value indicates the number of negative feedback entries that the eBay user, acting in the buying role, has left for their order partner (seller) during the last one-year period, counting back from the present date.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
FeedbackSummary .BuyerRoleMetrics .NeutralFeedbackLeftCount |
int | Conditionally |
This integer value indicates the number of neutral feedback entries that the eBay user, acting in the buying role, has left for their order partner (seller) during the last one-year period, counting back from the present date.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
FeedbackSummary .BuyerRoleMetrics .PositiveFeedbackLeftCount |
int | Conditionally |
This integer value indicates the number of positive feedback entries that the eBay user, acting in the buying role, has left for their order partner (seller) during the last one-year period, counting back from the present date.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
FeedbackSummary .NegativeFeedbackPeriodArray |
FeedbackPeriodArrayType | Conditionally |
Negative feedback entries count, for multiple predefined time periods preceding the call. Returned if no detail level is specified.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
FeedbackSummary .NegativeFeedbackPeriodArray .FeedbackPeriod |
FeedbackPeriodType | Conditionally,
repeatable: [0..*] |
Contains one feedback statistic giving length of the period being reported (e.g. last 7 days prior to the call), and total number of feedback entries (of the type given by the container, e.g. positive feedback) submitted during the indicated period. Returned if no detail level is specified.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
FeedbackSummary .NegativeFeedbackPeriodArray .FeedbackPeriod.Count |
int | Conditionally |
This integer value indicates the total number of Feedback entries that occurred within the time period specified in the PeriodInDays field. This field is always returned with the FeedbackPeriod container.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
FeedbackSummary .NegativeFeedbackPeriodArray .FeedbackPeriod.PeriodInDays |
int | Conditionally |
This integer value indicates the total number of days in the time period for the Feedback count. Typically, the returned time periods are 30 days, 180 days, and 365 days. This field is always returned with the FeedbackPeriod container.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
FeedbackSummary .NeutralCommentCountFromSuspendedUsers |
int | Conditionally |
Number of neutral comments received from suspended users. Returned if no detail level is specified.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
FeedbackSummary .NeutralFeedbackPeriodArray |
FeedbackPeriodArrayType | Conditionally |
Neutral feedback entries count, for multiple predefined time periods preceding the call. Returned if no detail level is specified.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
FeedbackSummary .NeutralFeedbackPeriodArray .FeedbackPeriod |
FeedbackPeriodType | Conditionally,
repeatable: [0..*] |
Contains one feedback statistic giving length of the period being reported (e.g. last 7 days prior to the call), and total number of feedback entries (of the type given by the container, e.g. positive feedback) submitted during the indicated period. Returned if no detail level is specified.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
FeedbackSummary .NeutralFeedbackPeriodArray .FeedbackPeriod.Count |
int | Conditionally |
This integer value indicates the total number of Feedback entries that occurred within the time period specified in the PeriodInDays field. This field is always returned with the FeedbackPeriod container.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
FeedbackSummary .NeutralFeedbackPeriodArray .FeedbackPeriod.PeriodInDays |
int | Conditionally |
This integer value indicates the total number of days in the time period for the Feedback count. Typically, the returned time periods are 30 days, 180 days, and 365 days. This field is always returned with the FeedbackPeriod container.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
FeedbackSummary .PositiveFeedbackPeriodArray |
FeedbackPeriodArrayType | Conditionally |
Positive feedback entries count, for multiple predefined time periods preceding the call. Returned if no detail level is specified.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
FeedbackSummary .PositiveFeedbackPeriodArray .FeedbackPeriod |
FeedbackPeriodType | Conditionally,
repeatable: [0..*] |
Contains one feedback statistic giving length of the period being reported (e.g. last 7 days prior to the call), and total number of feedback entries (of the type given by the container, e.g. positive feedback) submitted during the indicated period. Returned if no detail level is specified.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
FeedbackSummary .PositiveFeedbackPeriodArray .FeedbackPeriod.Count |
int | Conditionally |
This integer value indicates the total number of Feedback entries that occurred within the time period specified in the PeriodInDays field. This field is always returned with the FeedbackPeriod container.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
FeedbackSummary .PositiveFeedbackPeriodArray .FeedbackPeriod.PeriodInDays |
int | Conditionally |
This integer value indicates the total number of days in the time period for the Feedback count. Typically, the returned time periods are 30 days, 180 days, and 365 days. This field is always returned with the FeedbackPeriod container.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
FeedbackSummary .SellerRatingSummaryArray |
SellerRatingSummaryArrayType | Conditionally |
Container for information about detailed seller ratings (DSRs) that buyers have left for a seller. Sellers have access to the number of ratings they've received, as well as to the averages of DSRs they've received in each DSR area (i.e., to the average of ratings in the item-description area, etc.). The DSR feature is available everywhere on API-enabled country sites, including the US site (site ID 0).
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Seller ratings. |
FeedbackSummary .SellerRatingSummaryArray .AverageRatingSummary |
AverageRatingSummaryType | Conditionally,
repeatable: [0..*] |
Container consisting of a seller's Detailed Seller Rating (DSR) for each type of rating (Communication, Item As Described, Shipping and Handling Charges, or Shipping Time), the seller's average rating for each DSR type, the total number of DSR ratings for each DSR type, and the period in which those ratings were received (the last year or the last 30 days).
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
FeedbackSummary .SellerRatingSummaryArray .AverageRatingSummary .AverageRatingDetails |
AverageRatingDetailsType | Conditionally,
repeatable: [0..*] |
Applicable to sites that support the Detailed Seller Ratings feature. Each AverageRatingDetails container consists of the average detailed seller ratings in an area. 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.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
FeedbackSummary .SellerRatingSummaryArray .AverageRatingSummary .AverageRatingDetails.Rating |
double | Conditionally |
This value is the seller's average rating (given by buyers) for the DSR area noted in the corresponding RatingDetail field.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
FeedbackSummary .SellerRatingSummaryArray .AverageRatingSummary .AverageRatingDetails .RatingCount |
int | Conditionally |
This value is the total count of buyer ratings given for the DSR area noted in the corresponding RatingDetail field.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
FeedbackSummary .SellerRatingSummaryArray .AverageRatingSummary .AverageRatingDetails .RatingDetail |
FeedbackRatingDetailCodeType | Conditionally |
The value shown in this field indicates the Detailed Seller Rating area. The corresponding Rating value is the average rating that the seller has received for this DSR area, and the RatingCount value is the total number of buyer ratings that the seller has received in this DSR area. 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: Code so that your app gracefully handles any future changes to this list. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
FeedbackSummary .SellerRatingSummaryArray .AverageRatingSummary .FeedbackSummaryPeriod |
FeedbackSummaryPeriodCodeType | Conditionally |
This enumeration value will indicate whether the statistics in each AverageRatingDetails container is for the last year (FiftyTwoWeeks ) or the last month (ThirtyDays ).
Applicable values: Code so that your app gracefully handles any future changes to this list. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
FeedbackSummary .SellerRoleMetrics |
SellerRoleMetricsType | Conditionally |
Container for information about 1 year feedback metric as seller.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
FeedbackSummary .SellerRoleMetrics .CrossBorderTransactionCount |
int | Conditionally |
The count of Cross-Border Trade order line items.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
FeedbackSummary .SellerRoleMetrics .CrossBorderTransactionPercent |
float | Conditionally |
The percentage of order line items that are Cross-Border Trade order line items.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
FeedbackSummary .SellerRoleMetrics .FeedbackLeftPercent |
float | Conditionally |
Percentage of leaving feedback as a seller.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
FeedbackSummary .SellerRoleMetrics .NegativeFeedbackLeftCount |
int | Conditionally |
Count of negative feedback entries given as a seller.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
FeedbackSummary .SellerRoleMetrics .NeutralFeedbackLeftCount |
int | Conditionally |
Count of neutral feedback entries given as a seller.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
FeedbackSummary .SellerRoleMetrics .PositiveFeedbackLeftCount |
int | Conditionally |
Count of positive feedback entries given as a seller.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
FeedbackSummary .SellerRoleMetrics .RepeatBuyerCount |
int | Conditionally |
Number of buyers who bought more than once from this seller.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
FeedbackSummary .SellerRoleMetrics .RepeatBuyerPercent |
float | Conditionally |
Percentage of repeat buyers.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
FeedbackSummary .SellerRoleMetrics .TransactionPercent |
float | Conditionally |
Percentage of number of times a member has sold successfully vs. the number of times a member has bought an item in the preceding 365 days.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
FeedbackSummary .SellerRoleMetrics .UniqueBuyerCount |
int | Conditionally |
Count of unique buyers from this seller.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
FeedbackSummary .TotalFeedbackPeriodArray |
FeedbackPeriodArrayType | Conditionally |
Total feedback score, for multiple predefined time periods preceding the call. Returned if no detail level is specified.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
FeedbackSummary .TotalFeedbackPeriodArray .FeedbackPeriod |
FeedbackPeriodType | Conditionally,
repeatable: [0..*] |
Contains one feedback statistic giving length of the period being reported (e.g. last 7 days prior to the call), and total number of feedback entries (of the type given by the container, e.g. positive feedback) submitted during the indicated period. Returned if no detail level is specified.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
FeedbackSummary .TotalFeedbackPeriodArray .FeedbackPeriod.Count |
int | Conditionally |
This integer value indicates the total number of Feedback entries that occurred within the time period specified in the PeriodInDays field. This field is always returned with the FeedbackPeriod container.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
FeedbackSummary .TotalFeedbackPeriodArray .FeedbackPeriod.PeriodInDays |
int | Conditionally |
This integer value indicates the total number of days in the time period for the Feedback count. Typically, the returned time periods are 30 days, 180 days, and 365 days. This field is always returned with the FeedbackPeriod container.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
FeedbackSummary .UniqueNegativeFeedbackCount |
int | Conditionally |
Total number of negative Feedback comments, including weekly repeats. Returned if no detail level is specified.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
FeedbackSummary .UniqueNeutralFeedbackCount |
int | Conditionally |
Total number of neutral Feedback comments, including weekly repeats. Returned if no detail level is specified.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
FeedbackSummary .UniquePositiveFeedbackCount |
int | Conditionally |
Total number of positive Feedback comments, including weekly repeats. Returned if no detail level is specified.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
PageNumber | int | Always |
Indicates the page of data that is currently displaying. The page number to display is set in the Pagination.PageNumber field in the request. If this field is omitted, the PageNumber value defaults to 1 (first page of Feedback entries). If the integer value input into the Pagination.PageNumber field in the request is higher than the total number of available pages, the call fails with an error. This field is always returned even if the response is not showing any Feedback entries. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
PaginationResult | PaginationResultType | Always |
Contains information regarding the pagination of data, including the total number of Feedback entries and the total number of pages required to show all of these Feedback entries. The total number of pages is dependent on the Pagination.EntriesPerPage value (if set). The EntriesPerPage value defaults to 25 if the Pagination.EntriesPerPage field is not used. If the call request returns no Feedback entries because there are none, or because the DetailLevel field was not included and set to ReturnAll , the PaginationResult.TotalNumberOfPages and PaginationResult.TotalNumberOfEntries fields are still returned, but with values of 0 .
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
PaginationResult .TotalNumberOfEntries |
int | Always |
Indicates the total number of entries that could be returned by repeated call requests. Returned with a value of 0 if no entries are available.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
PaginationResult .TotalNumberOfPages |
int | Always |
Indicates the total number of pages of data that could be returned by repeated requests. Returned with a value of 0 if no pages are available.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
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
The DetailLevel input field influences which call-specific fields may be returned. (All standard output fields are returned regardless of DetailLevel.)
The none column indicates the fields that are returned when you do not specify a DetailLevel.
Y | The field is always returned. |
(Y) | The field is conditionally returned. See the field documentation for clarification of conditions. |
- | The field is not returned. |
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.
Retrieves the feedback for the user specified by UserID.
Description
A potential buyer found a book she wants to buy from m***************r and she wants to confirm the seller's feedback score before proceeding. This sample gets summary feedback information for the specified user.
Input
The only input needed for this sample is the UserID of the seller.
XML format.
<?xml version="1.0" encoding="utf-8"?>
<GetFeedbackRequest xmlns="urn:ebay:apis:eBLBaseComponents">
<RequesterCredentials>
<eBayAuthToken>A*******3</eBayAuthToken>
</RequesterCredentials>
<UserID>m***************r</UserID>
</GetFeedbackRequest>
Output
The important information in the response is FeedbackScore, which contains the aggregate feedback score, and the data in FeedbackSummary used to calculate the aggregate feedback score.
From the feedback scores, potential buyer sees that m***************r is a prolific seller on eBay, with a very positive feedback score. With this information, she feels that she can purchase the item knowing that she will get the item as advertised.
XML format.
<?xml version="1.0" encoding="UTF-8"?>
<GetFeedbackResponse
xmlns="urn:ebay:apis:eBLBaseComponents">
<Timestamp>2019-11-04T20:51:21.345Z</Timestamp>
<Ack>Success</Ack>
<Version>1119</Version>
<Build>E1119_CORE_APIFEEDBACK_19038728_R1</Build>
<FeedbackSummary>
<BidRetractionFeedbackPeriodArray>
<FeedbackPeriod>
<PeriodInDays>7</PeriodInDays>
<Count>0</Count>
</FeedbackPeriod>
<FeedbackPeriod>
<PeriodInDays>30</PeriodInDays>
<Count>0</Count>
</FeedbackPeriod>
<FeedbackPeriod>
<PeriodInDays>180</PeriodInDays>
<Count>0</Count>
</FeedbackPeriod>
</BidRetractionFeedbackPeriodArray>
<NegativeFeedbackPeriodArray>
<FeedbackPeriod>
<PeriodInDays>0</PeriodInDays>
<Count>18641</Count>
</FeedbackPeriod>
<FeedbackPeriod>
<PeriodInDays>30</PeriodInDays>
<Count>296</Count>
</FeedbackPeriod>
<FeedbackPeriod>
<PeriodInDays>180</PeriodInDays>
<Count>1833</Count>
</FeedbackPeriod>
<FeedbackPeriod>
<PeriodInDays>365</PeriodInDays>
<Count>4758</Count>
</FeedbackPeriod>
</NegativeFeedbackPeriodArray>
<NeutralFeedbackPeriodArray>
<FeedbackPeriod>
<PeriodInDays>0</PeriodInDays>
<Count>15049</Count>
</FeedbackPeriod>
<FeedbackPeriod>
<PeriodInDays>30</PeriodInDays>
<Count>215</Count>
</FeedbackPeriod>
<FeedbackPeriod>
<PeriodInDays>180</PeriodInDays>
<Count>1450</Count>
</FeedbackPeriod>
<FeedbackPeriod>
<PeriodInDays>365</PeriodInDays>
<Count>3676</Count>
</FeedbackPeriod>
</NeutralFeedbackPeriodArray>
<PositiveFeedbackPeriodArray>
<FeedbackPeriod>
<PeriodInDays>0</PeriodInDays>
<Count>3159359</Count>
</FeedbackPeriod>
<FeedbackPeriod>
<PeriodInDays>30</PeriodInDays>
<Count>40503</Count>
</FeedbackPeriod>
<FeedbackPeriod>
<PeriodInDays>180</PeriodInDays>
<Count>290379</Count>
</FeedbackPeriod>
<FeedbackPeriod>
<PeriodInDays>365</PeriodInDays>
<Count>669953</Count>
</FeedbackPeriod>
</PositiveFeedbackPeriodArray>
<TotalFeedbackPeriodArray>
<FeedbackPeriod>
<PeriodInDays>30</PeriodInDays>
<Count>41014</Count>
</FeedbackPeriod>
<FeedbackPeriod>
<PeriodInDays>180</PeriodInDays>
<Count>293662</Count>
</FeedbackPeriod>
<FeedbackPeriod>
<PeriodInDays>365</PeriodInDays>
<Count>678387</Count>
</FeedbackPeriod>
</TotalFeedbackPeriodArray>
<NeutralCommentCountFromSuspendedUsers>0</NeutralCommentCountFromSuspendedUsers>
<UniqueNegativeFeedbackCount>16702</UniqueNegativeFeedbackCount>
<UniquePositiveFeedbackCount>2187099</UniquePositiveFeedbackCount>
<UniqueNeutralFeedbackCount>13608</UniqueNeutralFeedbackCount>
<SellerRatingSummaryArray>
<AverageRatingSummary>
<FeedbackSummaryPeriod>FiftyTwoWeeks</FeedbackSummaryPeriod>
<AverageRatingDetails>
<RatingDetail>ItemAsDescribed</RatingDetail>
<Rating>4.9</Rating>
<RatingCount>415014</RatingCount>
</AverageRatingDetails>
<AverageRatingDetails>
<RatingDetail>Communication</RatingDetail>
<Rating>4.9</Rating>
<RatingCount>420302</RatingCount>
</AverageRatingDetails>
<AverageRatingDetails>
<RatingDetail>ShippingTime</RatingDetail>
<Rating>5.0</Rating>
<RatingCount>435823</RatingCount>
</AverageRatingDetails>
<AverageRatingDetails>
<RatingDetail>ShippingAndHandlingCharges</RatingDetail>
<Rating>5.0</Rating>
<RatingCount>439989</RatingCount>
</AverageRatingDetails>
</AverageRatingSummary>
<AverageRatingSummary>
<FeedbackSummaryPeriod>ThirtyDays</FeedbackSummaryPeriod>
<AverageRatingDetails>
<RatingDetail>ItemAsDescribed</RatingDetail>
<Rating>4.9</Rating>
<RatingCount>24027</RatingCount>
</AverageRatingDetails>
<AverageRatingDetails>
<RatingDetail>Communication</RatingDetail>
<Rating>4.9</Rating>
<RatingCount>23738</RatingCount>
</AverageRatingDetails>
<AverageRatingDetails>
<RatingDetail>ShippingTime</RatingDetail>
<Rating>5.0</Rating>
<RatingCount>25194</RatingCount>
</AverageRatingDetails>
<AverageRatingDetails>
<RatingDetail>ShippingAndHandlingCharges</RatingDetail>
<Rating>5.0</Rating>
<RatingCount>25393</RatingCount>
</AverageRatingDetails>
</AverageRatingSummary>
</SellerRatingSummaryArray>
<SellerRoleMetrics>
<PositiveFeedbackLeftCount>1618174</PositiveFeedbackLeftCount>
<NegativeFeedbackLeftCount>0</NegativeFeedbackLeftCount>
<NeutralFeedbackLeftCount>0</NeutralFeedbackLeftCount>
<FeedbackLeftPercent>92.0</FeedbackLeftPercent>
<RepeatBuyerCount>0</RepeatBuyerCount>
<RepeatBuyerPercent>0.0</RepeatBuyerPercent>
<UniqueBuyerCount>2</UniqueBuyerCount>
<TransactionPercent>100.0</TransactionPercent>
<CrossBorderTransactionCount>19366</CrossBorderTransactionCount>
<CrossBorderTransactionPercent>1.1</CrossBorderTransactionPercent>
</SellerRoleMetrics>
<BuyerRoleMetrics>
<PositiveFeedbackLeftCount>0</PositiveFeedbackLeftCount>
<NegativeFeedbackLeftCount>0</NegativeFeedbackLeftCount>
<NeutralFeedbackLeftCount>0</NeutralFeedbackLeftCount>
<FeedbackLeftPercent>0.0</FeedbackLeftPercent>
</BuyerRoleMetrics>
</FeedbackSummary>
<FeedbackScore>2171418</FeedbackScore>
<PaginationResult>
<TotalNumberOfPages>0</TotalNumberOfPages>
<TotalNumberOfEntries>0</TotalNumberOfEntries>
</PaginationResult>
<EntriesPerPage>25</EntriesPerPage>
<PageNumber>1</PageNumber>
</GetFeedbackResponse>
Input Output Detail Controls Samples |
Change History
Change Date | Description |
---|---|
691 2010-10-14 |
|
1139 2020-01-31 |
|
0705 2011-01-19 |
|
0605 2009-02-18 |
|
0567 2008-05-28 |
|
0563 2008-04-30 |
|
0549 2008-01-24 |
|
0531 2007-09-19 |
|
0501 2007-02-21 |
|
0499 2007-02-07 |
|
0483 2006-10-18 |
|
0443 2006-01-11 |
|
0435 2005-11-16 |
|