GetFeedback

Retrieves summary feedback data if Transaction ID or Item ID are specified. Retrieves the accumulation of feedback left for the specified user by other users if a User ID is specified. Retrieves the accumulation of feedback left for the requesting user if no ID value is entered.
If a detail level value of ReturnAll is specified, the data for each feedback record is returned.

See:
    Leaving and Retrieving Feedback
    GetFeedback



Back to top

GetFeedback Input

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

See also Samples.

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

The XML prototype may be missing some XML fields and attributes. This is a documentation limitation only (see Limitations of This Document).

<?xml version="1.0" encoding="utf-8"?>
<GetFeedbackRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Standard Input Fields -->
  <DetailLevel> DetailLevelCodeType </DetailLevel>
  <!-- ... more DetailLevel nodes here ... -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <OutputSelector> string </OutputSelector>
  <!-- ... more OutputSelector nodes here ... -->
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
  <!-- Call-specific Input Fields -->
  <CommentType> CommentTypeCodeType </CommentType>
  <!-- ... more CommentType nodes here ... -->
  <FeedbackID> string </FeedbackID>
  <ItemID> ItemIDType (string) </ItemID>
  <Pagination> PaginationType 
    <EntriesPerPage> int </EntriesPerPage>
    <PageNumber> int </PageNumber>
  </Pagination>
  <TransactionID> string </TransactionID>
  <UserID> UserIDType (string) </UserID>
</GetFeedbackRequest>
Argument Type Reqd? Meaning
Standard Input Fields   [Jump to call-specific fields]
DetailLevel DetailLevelCodeType
(repeatable)
Optional 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 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. (Some detail level tables are still in the eBay Web Services guide. They will be moved to the Input/Output Reference in a future release.)

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 a GranularityLevel or use the GetSellerEvents call instead. If you do use ReturnAll with GetSellerList, use a small EntriesPerPage value and a short EndTimeFrom/EndTimeTo range for better performance.

Applicable values:

•   ReturnAll

(in) Returns all available data. With GetSellerList and other calls that retrieve large data sets, please avoid using ReturnAll when possible. For example, if you use GetSellerList, use a GranularityLevel or use the GetSellerEvents call instead. If you use ReturnAll with GetSellerList, use a small EntriesPerPage value and a short EndTimeFrom/EndTimeTo range for better performance.


(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. Specify the standard RFC 3066 language identification tag (e.g., en_US).
ID--- country
----- -----
de_AT Austria
de_CH Switzerland
de_DE Germany
en_AU Australia
en_CA Canada
en_GB United Kingdom
en_SG Singapore
en_US United States
es_ES Spain
fr_BE Belgium (French)
fr_CA Canada (French)
fr_FR France
it_IT Italy
nl_BE Belgium (Dutch)
nl_NL Netherlands
zh_CN China
en_IN India
en_IE Ireland
zh_HK Hong Kong

See Tags for the Identification of Languages.
MessageID string Optional In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned.

Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage 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, 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
(repeatable)
Optional You can use the OutputSelector field to restrict the data returned by this call. When you make a call such as GetItem that retrieves data from eBay, the OutputSelector field is useful for restricting the data returned. This field makes the call response easier to use, especially when a large payload would be returned. If you use the OutputSelector field, the output data will include only the fields you specified in the request. For example, if you are using GetItem and you want the item data in the response to be restricted to the ViewItemURL (the URL where a user can view the listing) and BuyItNowPrice, then within the GetItem request, specify those output fields. To use this field, see the information at the following link.

See Selecting Fields to Retrieve.
Version string Conditional The version number of the API code that you are programming against (e.g., 549). The version you specify for a call has these basic effects:
- It indicates the version of the code lists and other data that eBay should use to process your request.
- It indicates the schema version you are using.
You need to use a version that is greater than or equal to the lowest supported version.

For the SOAP API: If you are using the SOAP API, this field is required. Specify the version of the WSDL your application is using.

For the XML API: If you are using the XML API, this field has no effect. Instead, specify the version in the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header. (If you specify Version in the body of an XML API request and it is different from the value in the HTTP header, eBay returns an informational warning that the value in the HTTP header was used instead.)

See:
    HTTP Headers (XML API Only)
    eBay Schema Versioning Strategy
    Lowest Supported Version
WarningLevel WarningLevelCodeType Optional Controls whether or not to return warnings when the application passes unrecognized or deprecated elements in a request.

An unrecognized element is one that is not defined in any supported version of the schema. Schema element names are case-sensitive, so using WarningLevel can also help you remove any potential hidden bugs within your application due to incorrect case or spelling in field names before you put your application into the Production environment.

WarningLevel only validates elements; it doesn't validate XML attributes. It also doesn't control warnings related to user-entered strings or numbers, or warnings for logical errors.

We recommend that you only use this during development and debugging. Do not use this in requests in your production code.

Applicable values:

•   High

(in) Return warnings when the application passes unrecognized or deprecated elements in a request.

•   Low

(in) Do not return warnings when the application passes unrecognized or deprecated elements in a request. This is the default value if WarningLevel is not specified.




See Warning Level.
Call-specific Input Fields
CommentType CommentTypeCodeType
(repeatable)
Optional Returns feedback of a specified type (positive, negative, or neutral) in a FeedbackDetailArray. You can include two CommentTypes in your call if you want to exclude the third type from your results. If no CommentType is specified, all of the feedback details will be returned.

Applicable values:

•   CustomCode

(in/out) Reserved for internal or future use.

•   IndependentlyWithdrawn

(in/out) Applies to the eBay Motors site only. Feedback is withdrawn based on the decision of a third party.

•   Negative

(in/out) Negative feedback. Decreases total feedback score.

•   Neutral

(in/out) Neutral feedback. No effect on total feedback score.

•   Positive

(in/out) Positive feedback. Increases total feedback score.

•   Withdrawn

(in/out) Withdrawn feedback. Removes the effect of the original feedback on total feedback score. Comments from withdrawn feedback are still visible.


FeedbackID string Optional An ID that uniquely identifies a feedback record to be retrieved. Used by the Feedback notification only.
ItemID ItemIDType (string) Optional Specifies the item ID whose feedback data is to be returned. If not specified, then the feedback for all items is returned. When an Item ID is specified, the maximum number of feedback records returned is 100 and Pagination is ignored.
Max length: 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits).
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 a detail level value of ReturnAll is specified and the UserID or no ID (requester option) is specified. Feedback summary data is not paginated (but is still returned when pagination is used).
Valid Pagination.EntriesPerPage input for GetFeedback is limited to 25, 50, 100, and 200. Other values will be treated as the closest valid input less than the value specified or 25. If a value of zero or less or a value greater than 200 is specified, the call fails with an error. When pagination is used and feedback detail entries are being returned, the summary data is returned after the last feedback detail entry on the last page of data.
Pagination.EntriesPerPage int Optional Specifies the maximum number of entries to return in a single call. If the number of entries that can be returned is less than the value in EntriesPerPage, then the lower number is returned. For most calls, the max is 200 and the default is 25. For GetUserDisputes, the value is hard-coded at 200, and any input is ignored. For GetProducts, the maximum is 20 (and higher values are ignored). See the annotations for other individual calls to determine the correct max and default values. For GetOrders, not applicable to eBay.com (but applicable to Half.com for GetOrders).
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 other individual calls to determine the correct default value. For GetOrders, not applicable to eBay.com (for GetOrders, applicable to Half.com).
Min: 0. Max: 2147483647. Default: 0.
TransactionID string Optional Transaction ID whose feedback record should be returned. If not specified, then the feedback for all transactions will be returned. When a Transaction ID is specified, since only one record is returned, Pagination is ignored.
Max length: 19 (Note: The eBay database specifies 38. Currently, transaction IDs are usually 9 to 12 digits.).
UserID UserIDType (string) Optional Specifies the user whose feedback data is to be returned. If not specified, then the feedback returned is for the requesting user.



Back to top

GetFeedback Output

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

See also Samples.

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

The XML prototype may be missing some XML fields and attributes. This is a documentation limitation only (see Limitations of This Document).

<?xml version="1.0" encoding="utf-8"?>
<GetFeedbackResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- 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 here ... -->
    <LongMessage> string </LongMessage>
    <SeverityCode> SeverityCodeType </SeverityCode>
    <ShortMessage> string </ShortMessage>
  </Errors>
  <!-- ... more Errors nodes here ... -->
  <HardExpirationWarning> string </HardExpirationWarning>
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
  <!-- 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>
      <FeedbackResponse> string </FeedbackResponse>
      <Followup> string </Followup>
      <FollowUpReplaced> boolean </FollowUpReplaced>
      <ItemID> ItemIDType (string) </ItemID>
      <ItemPrice> AmountType (double) </ItemPrice>
      <ItemTitle> string </ItemTitle>
      <ResponseReplaced> boolean </ResponseReplaced>
      <Role> TradingRoleCodeType </Role>
      <TransactionID> string </TransactionID>
    </FeedbackDetail>
    <!-- ... more FeedbackDetail nodes here ... -->
  </FeedbackDetailArray>
  <FeedbackDetailItemTotal> int </FeedbackDetailItemTotal>
  <FeedbackScore> int </FeedbackScore>
  <FeedbackSummary> FeedbackSummaryType 
    <BidRetractionFeedbackPeriodArray> FeedbackPeriodArrayType 
      <FeedbackPeriod> FeedbackPeriodType 
        <Count> int </Count>
        <PeriodInDays> int </PeriodInDays>
      </FeedbackPeriod>
      <!-- ... more FeedbackPeriod nodes 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 here ... -->
    </NegativeFeedbackPeriodArray>
    <NeutralCommentCountFromSuspendedUsers> int </NeutralCommentCountFromSuspendedUsers>
    <NeutralFeedbackPeriodArray> FeedbackPeriodArrayType 
      <FeedbackPeriod> FeedbackPeriodType 
        <Count> int </Count>
        <PeriodInDays> int </PeriodInDays>
      </FeedbackPeriod>
      <!-- ... more FeedbackPeriod nodes here ... -->
    </NeutralFeedbackPeriodArray>
    <PositiveFeedbackPeriodArray> FeedbackPeriodArrayType 
      <FeedbackPeriod> FeedbackPeriodType 
        <Count> int </Count>
        <PeriodInDays> int </PeriodInDays>
      </FeedbackPeriod>
      <!-- ... more FeedbackPeriod nodes here ... -->
    </PositiveFeedbackPeriodArray>
    <SellerRatingSummaryArray> SellerRatingSummaryArrayType 
      <AverageRatingSummary> AverageRatingSummaryType 
        <AverageRatingDetails> AverageRatingDetailsType 
          <Rating> double </Rating>
          <RatingCount> int </RatingCount>
          <RatingDetail> FeedbackRatingDetailCodeType </RatingDetail>
        </AverageRatingDetails>
        <!-- ... more AverageRatingDetails nodes here ... -->
        <FeedbackSummaryPeriod> FeedbackSummaryPeriodCodeType </FeedbackSummaryPeriod>
      </AverageRatingSummary>
      <!-- ... more AverageRatingSummary nodes 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 here ... -->
    </TotalFeedbackPeriodArray>
    <UniqueNegativeFeedbackCount> int </UniqueNegativeFeedbackCount>
    <UniqueNeutralFeedbackCount> int </UniqueNeutralFeedbackCount>
    <UniquePositiveFeedbackCount> int </UniquePositiveFeedbackCount>
  </FeedbackSummary>
  <PageNumber> int </PageNumber>
  <PaginationResult> PaginationResultType 
    <TotalNumberOfEntries> int </TotalNumberOfEntries>
    <TotalNumberOfPages> int </TotalNumberOfPages>
  </PaginationResult>
</GetFeedbackResponse>
Return Value Type Returned? Meaning
Standard Output Fields   [Jump to call-specific fields]
Ack AckCodeType Always A token representing the application-level acknowledgement code that indicates the response status (e.g., success). The AckCodeType list specifies the possible values for Ack.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   Failure

(out) Request processing failed

•   Success

(out) Request processing succeeded

•   Warning

(out) Request processing completed with warning information being included in the response message


(Not all values in AckCodeType apply to this field.)
Build string Always This refers to the specific software build that eBay used when processing the request and generating the response. This includes the version number plus additional information. eBay Developer Support may request the build information when helping you resolve technical issues.
CorrelationID string Conditionally In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned.

Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage 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, 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
(repeatable)
Conditionally A list of application-level errors (if any) that occurred when eBay processed the request.

See Error Handling.
Errors.ErrorClassification ErrorClassificationCodeType Conditionally API errors are divided between two classes: system errors and request errors.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   RequestError

(out) An error has occurred either as a result of a problem in the sending application or because the application's end-user has attempted to submit invalid data (or missing data). In these cases, do not retry the request. The problem must be corrected before the request can be made again. If the problem is due to something in the application (such as a missing required field), the application must be changed. If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the application or data is resolved, resend the request to eBay with the corrected data.

•   SystemError

(out) Indicates that an error has occurred on the eBay system side, such as a database or server down. An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.


Errors.ErrorCode token Conditionally A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms.
Errors.ErrorParameters ErrorParameterType
(repeatable)
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
  [ attribute ParamID ]
string Conditionally The index of the parameter in the list of parameter types returned within the error type.
Errors.ErrorParameters.Value string Conditionally The value of the variable (e.g., the attribute set ID)
Errors.LongMessage string Conditionally A more detailed description of the condition that raised the error.
Errors.SeverityCode SeverityCodeType Conditionally Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use

•   Error

(out) Application-level error

•   Warning

(out) Warning or informational error


Errors.ShortMessage string Conditionally A brief description of the condition that raised the error.
HardExpirationWarning string Conditionally Expiration date of the user's authentication token. Only returned within the 7-day period prior to a token's expiration. To ensure that user authentication tokens are secure and to help avoid a user's token being compromised, tokens have a limited life span. A token is only valid for a period of time (set by eBay). After this amount of time has passed, the token expires and must be replaced with a new token.
Timestamp dateTime Always This value represents the date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See Time Values in the eBay Web Services guide for information about this time format and converting to and from the GMT time zone.

Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, this time value reflects the time the cached response was created. Thus, this value is not necessarily when the request was processed. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, this time value does reflect when the request was processed.
Version string Always The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. See "Standard Data for All Calls" in the eBay Web Services Guide for information on using the response version when troubleshooting "CustomCode" values that appear in the response.
Call-specific Output Fields
EntriesPerPage int Conditionally Indicates the number of entries (feedback detail) that are being returned per page of data (i.e., per call). Only returned if entries are returned.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
FeedbackDetailArray FeedbackDetailArrayType Conditionally Contains the individual feedback records for the user, transaction, or item is specified in the request. There is one FeedbackDetailType object for each feedback record. Only populated with data when a detail level of ReturnAll is specified in the request. Not returned if you specify FeedbackID in the request.

DetailLevel: ReturnAll.
FeedbackDetailArray
  .FeedbackDetail
FeedbackDetailType
(repeatable)
Conditionally Contains a single feedback detail entry. Output only.

DetailLevel: ReturnAll.
FeedbackDetailArray
  .FeedbackDetail.CommentingUser
UserIDType (string) Conditionally eBay user ID for the user who left the feedback. Returned for a detail level of ReturnAll (if the parent is returned).

DetailLevel: ReturnAll.
FeedbackDetailArray
  .FeedbackDetail
  .CommentingUserScore
int Conditionally Feedback score of the user indicated in CommentingUser. Returned for a detail level of ReturnAll (if the parent is returned).

DetailLevel: ReturnAll.
FeedbackDetailArray
  .FeedbackDetail
  .CommentReplaced
boolean Conditionally Indicates whether eBay replaced the comment with a message that the comment was removed.

DetailLevel: ReturnAll.
FeedbackDetailArray
  .FeedbackDetail.CommentText
string Conditionally Text message left by user specified in CommentingUser. Used to provide a more in-depth description of the user's opinion of their transaction with the user about whom they left feedback. Returned as text in the language that the comment was originally left in. Returned for a detail level of ReturnAll (if the parent is returned).
Max length: 80 (125 for Taiwan).

DetailLevel: ReturnAll.
FeedbackDetailArray
  .FeedbackDetail.CommentTime
dateTime Conditionally Date and time (in GMT) that the feedback was submitted to eBay. Returned for a detail level of ReturnAll (if the parent is returned).

DetailLevel: ReturnAll.
FeedbackDetailArray
  .FeedbackDetail.CommentType
CommentTypeCodeType Conditionally Type of feedback. Can be Positive, Neutral, Negative, or Withdrawn (see the CommentTypeCodeType code list). Positive feedbacks add to the user's total feedback score, negative feedbacks lower the score, and neutral feedbacks do not affect the score (but do affect the overall picture of the user's online reputation). Returned for a detail level of ReturnAll (if the parent is returned).

Applicable values:

•   CustomCode

(in/out) Reserved for internal or future use.

•   IndependentlyWithdrawn

(in/out) Applies to the eBay Motors site only. Feedback is withdrawn based on the decision of a third party.

•   Negative

(in/out) Negative feedback. Decreases total feedback score.

•   Neutral

(in/out) Neutral feedback. No effect on total feedback score.

•   Positive

(in/out) Positive feedback. Increases total feedback score.

•   Withdrawn

(in/out) Withdrawn feedback. Removes the effect of the original feedback on total feedback score. Comments from withdrawn feedback are still visible.




DetailLevel: ReturnAll.
FeedbackDetailArray
  .FeedbackDetail.Countable
boolean Conditionally Specifies if a user's feedback score is or is not countable. This field is returned only when a user's feedback score is not countable (value is false).

Only feedback left by verified users can count toward the aggregate score of another user. If a user is not verified and leaves a feedback, then later becomes verified, that feedback will still not be counted. Or, if a user is verified and at some later date changes to unverified status, the feedback left while the user was verified remains countable. So you cannot determine a user's current verification status from whether or not feedback they've left is or was countable. Whether or not feedback is countable has nothing to do with the verification status of the one receiving the comment, only the one leaving the feedback.
Default: true.

DetailLevel: ReturnAll.

See (GetUser) ItemDetails.
FeedbackDetailArray
  .FeedbackDetail.FeedbackID
string Conditionally Unique identifier for the feedback entry. Returned for a detail level of ReturnAll (if the parent is returned).

DetailLevel: ReturnAll.
FeedbackDetailArray
  .FeedbackDetail
  .FeedbackResponse
string Conditionally Textual comment that the user targeted by feedback may leave in response or rebuttal to the feedback. (Cannot be submitted or edited via the API.)
Max length: 80 (125 for Taiwan).

DetailLevel: ReturnAll.
FeedbackDetailArray
  .FeedbackDetail.Followup
string Conditionally Explanation a user can give to a response. (Cannot be submitted or edited via the API.) Returned for a detail level of ReturnAll (if the parent is returned).
Max length: 80 (125 for Taiwan).

DetailLevel: ReturnAll.
FeedbackDetailArray
  .FeedbackDetail
  .FollowUpReplaced
boolean Conditionally Indicates whether eBay replaced the follow-up with a message that the follow-up was removed.

DetailLevel: ReturnAll.
FeedbackDetailArray
  .FeedbackDetail.ItemID
ItemIDType (string) Conditionally The ID that uniquely identifies the item listing. Returned for a detail level of ReturnAll (if the parent is returned).
Max length: 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits).

DetailLevel: ReturnAll.
FeedbackDetailArray
  .FeedbackDetail.ItemPrice
AmountType (double) Conditionally The final price for the item, associated with the currency identified by the currencyId attribute of the AmountType. This value can be returned as part of the Detailed Seller Ratings feature. Not returned if a listing ended more than 90 days ago.

DetailLevel: ReturnAll.

See Detailed Seller Ratings.
FeedbackDetailArray
  .FeedbackDetail.ItemTitle
string Conditionally Name of the listing for which feedback was provided. 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.
Max length: 55.

DetailLevel: ReturnAll.

See Detailed Seller Ratings.
FeedbackDetailArray
  .FeedbackDetail
  .ResponseReplaced
boolean Conditionally Indicates whether eBay replaced the response with a message that the response was removed.

DetailLevel: ReturnAll.
FeedbackDetailArray
  .FeedbackDetail.Role
TradingRoleCodeType Conditionally Indicates whether the user who was the feedback recipient was a Buyer or the Seller for that transaction. Returned for a detail level of ReturnAll (if the parent is returned).

Applicable values:

•   Buyer

(in/out) Acting as buyer.

•   CustomCode

(in/out) Reserved for future use.

•   Seller

(in/out) Acting as seller. For GetOrders, you can use this value to limit orders to those where the calling user is the seller.




DetailLevel: ReturnAll.
FeedbackDetailArray
  .FeedbackDetail.TransactionID
string Conditionally Unique identifier for the transaction about which this feedback entry was left. This field is not returned in the case of TransactionIDs from Chinese auction listings, because a value of zero is used for TransactionIDs in such cases.
Max length: 19 (Note: The eBay database specifies 38. Currently, transaction IDs are usually 9 to 12 digits.).

DetailLevel: ReturnAll.
FeedbackDetailItemTotal int Conditionally Indicates the number of FeedbackDetailType objects returned in the FeedbackDetailArray property. 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 predefined 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
(repeatable)
Conditionally 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 Count of the feedbacks received by the user for the time period prior to the call indicated in PeriodInDays. Returned if no detail level is specified.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
FeedbackSummary
  .BidRetractionFeedbackPeriodArray
  .FeedbackPeriod.PeriodInDays
int Conditionally Indicates the time period for the feedback count. Returns a value indicating the number of days prior to the call for which feedbacks of the particular type are counted. Returned if no detail level is specified.

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 Percentage of leaving feedback as a buyer.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
FeedbackSummary
  .BuyerRoleMetrics
  .NegativeFeedbackLeftCount
int Conditionally Count of negative feedback entries given as a buyer.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
FeedbackSummary
  .BuyerRoleMetrics
  .NeutralFeedbackLeftCount
int Conditionally Count of neutral feedback entries given as a buyer.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
FeedbackSummary
  .BuyerRoleMetrics
  .PositiveFeedbackLeftCount
int Conditionally Count of positive feedback entries given as a buyer.

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
(repeatable)
Conditionally 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 Count of the feedbacks received by the user for the time period prior to the call indicated in PeriodInDays. Returned if no detail level is specified.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
FeedbackSummary
  .NegativeFeedbackPeriodArray
  .FeedbackPeriod.PeriodInDays
int Conditionally Indicates the time period for the feedback count. Returns a value indicating the number of days prior to the call for which feedbacks of the particular type are counted. Returned if no detail level is specified.

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
(repeatable)
Conditionally 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 Count of the feedbacks received by the user for the time period prior to the call indicated in PeriodInDays. Returned if no detail level is specified.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
FeedbackSummary
  .NeutralFeedbackPeriodArray
  .FeedbackPeriod.PeriodInDays
int Conditionally Indicates the time period for the feedback count. Returns a value indicating the number of days prior to the call for which feedbacks of the particular type are counted. Returned if no detail level is specified.

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
(repeatable)
Conditionally 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 Count of the feedbacks received by the user for the time period prior to the call indicated in PeriodInDays. Returned if no detail level is specified.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
FeedbackSummary
  .PositiveFeedbackPeriodArray
  .FeedbackPeriod.PeriodInDays
int Conditionally Indicates the time period for the feedback count. Returns a value indicating the number of days prior to the call for which feedbacks of the particular type are counted. Returned if no detail level is specified.

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 on the United Kingdom site and on the following other sites: AU (site ID 15), BEFR (site ID 23), BENL (site ID 123), FR (site ID 71), IE (site ID 205), IN (site ID 203), IT (site ID 101), and PL (site ID 212). The DSR feature is available on the other API-enabled country sites, including the US site (site ID 0).

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

See Detailed Seller Ratings.
FeedbackSummary
  .SellerRatingSummaryArray
  .AverageRatingSummary
AverageRatingSummaryType
(repeatable)
Conditionally Average detailed seller ratings for specific periods.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
FeedbackSummary
  .SellerRatingSummaryArray
  .AverageRatingSummary
  .AverageRatingDetails
AverageRatingDetailsType
(repeatable)
Conditionally Applicable to sites that support the Detailed Seller Ratings feature. The AverageRatingDetails container has information about average detailed seller ratings. 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. Users retrieve detailed ratings as averages of the ratings left by buyers.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
FeedbackSummary
  .SellerRatingSummaryArray
  .AverageRatingSummary
  .AverageRatingDetails.Rating
double Conditionally An average detailed seller rating applying to the area in the corresponding RatingDetail field.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
FeedbackSummary
  .SellerRatingSummaryArray
  .AverageRatingSummary
  .AverageRatingDetails
  .RatingCount
int Conditionally The number of detailed seller ratings in the area in the corresponding RatingDetail field.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
FeedbackSummary
  .SellerRatingSummaryArray
  .AverageRatingSummary
  .AverageRatingDetails
  .RatingDetail
FeedbackRatingDetailCodeType Conditionally The area of a specific average detailed seller rating. Users retrieve detailed ratings as averages of the ratings left by buyers. 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:

•   Communication

(in/out) Detailed seller rating in the area of "communication."

•   CustomCode

(in/out) Reserved for internal or future use.

•   ItemAsDescribed

(in/out) Detailed seller rating in the area of "item as described."

•   ShippingAndHandlingCharges

(in/out) Detailed seller rating in the area of "charges for shipping and handling." Inapplicable to motor vehicle items.

•   ShippingTime

(in/out) Detailed seller rating in the area of "shipping time." Inapplicable to motor vehicle items.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
FeedbackSummary
  .SellerRatingSummaryArray
  .AverageRatingSummary
  .FeedbackSummaryPeriod
FeedbackSummaryPeriodCodeType Conditionally The summary period for which the detail ratings are calculated.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   FiftyTwoWeeks

(out) Period including the last 52 weeks from today.

•   ThirtyDays

(out) Period including the last 30 days from today.




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 Count of transactions done cross-border.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
FeedbackSummary
  .SellerRoleMetrics
  .CrossBorderTransactionPercent
float Conditionally Percentage of cross-border transactions.

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
(repeatable)
Conditionally 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 Count of the feedbacks received by the user for the time period prior to the call indicated in PeriodInDays. Returned if no detail level is specified.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
FeedbackSummary
  .TotalFeedbackPeriodArray
  .FeedbackPeriod.PeriodInDays
int Conditionally Indicates the time period for the feedback count. Returns a value indicating the number of days prior to the call for which feedbacks of the particular type are counted. Returned if no detail level is specified.

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 Conditionally Indicates which page of data was just returned. Will be the same as the value specified in Pagination.PageNumber. (If the input is higher than the total number of pages, the call fails with an error.) Only returned if items are returned.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
PaginationResult PaginationResultType Always Contains information regarding the pagination of data (if pagination is used), including total number of pages and total number of entries. This is only applicable when a User ID or no ID (requester option) is specified.

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 requests. For GetOrders, not applicable to eBay.com (for GetOrders, applicable to Half.com). 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. For GetOrders, not applicable to eBay.com (for GetOrders, applicable to Half.com). Returned with a value of 0 if no pages are available.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.



Back to top