eBay Trading API
|
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.
GetFeedback takes the following values as input filters: UserID, Item ID, Transaction ID, or OrderLineItemID. See the Call 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.
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.
You can test GetFeedback in the Sandbox environment. For best results:
See:
Leaving and Retrieving Feedback
Introduction to Feedback
Getting Feedback Left By Another User
Detailed Seller Ratings
See also the reference documentation for these calls:
| Output Detail Controls Samples Change History Top Errors for GetFeedback User Notes |
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 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..*] |
Returns feedback of a specified type (positive, negative, or neutral) in FeedbackDetailArray. You can include two comment types in your call if you want to exclude the third type from your results. If no CommentType is specified, all of the feedback types are returned.
Applicable values: • CustomCode (in/out) This value is reserved for internal or future use. • IndependentlyWithdrawn (in/out) This value indicates that a submitted Feedback entry was withdrawn based on the decision of a third-party (such as eBay). If a Feedback entry is withdrawn, the effect of that entry on the overall Feedback score is nullified. • Negative (in/out) This value indicates that the submitting user's experience with the other user (receiving feedback) was rated as a "Negative" experience. If an eBay user receives a Negative rating for an order line item from a Verified User, their overall Feedback score decreases by a value of 1. • Neutral (in/out) This value indicates that the submitting user's experience with the other user (receiving feedback) was rated as a "Neutral" experience. If an eBay user receives a Neutral rating for an order line item from a Verified User, their overall Feedback score remains the same. • Positive (in/out) This value indicates that the submitting user's experience with the other user (receiving feedback) was rated as a "Positive" experience. If an eBay user receives a Positive rating for an order line item from a Verified User, their overall Feedback score increases by a value of 1. • Withdrawn (in/out) This value indicates that a submitted Feedback entry was withdrawn. If a Feedback entry is withdrawn, the effect of that entry on the overall Feedback score is nullified. However, Feedback comments from the withdrawn entry are still visible. |
| FeedbackID | string | Optional | An ID that uniquely identifies a feedback record to be retrieved. Used only by the Feedback notification. |
| FeedbackType | FeedbackTypeCodeType | Optional |
Returns feedback that you received as a buyer or seller, or feedback you left for others (as either a buyer or a seller). You can include only one FeedbackType in your call. If no FeedbackType is specified, all of the available feedback is returned.
Applicable values: • CustomCode (in) Reserved for internal or future use. • FeedbackLeft (in) Feedback left for others. • FeedbackReceived (in) Retrieves feedback left by all buyers and all sellers for this user. • FeedbackReceivedAsBuyer (in) Retrieves feedback left by all sellers for this user. • FeedbackReceivedAsSeller (in) Retrieves feedback left by all buyers for this user. |
| ItemID | ItemIDType (string) | Optional |
Unique identifier for an eBay item listing. A listing can have multiple order line items (transactions), but only one ItemID. If ItemID is specified in the GetFeedback request, the returned feedback records are restricted to the specified ItemID. The FeedbackType and Pagination fields (if included) are ignored. The maximum number of feedback records returned is 100. Max length: 19 (Note: The eBay database specifies 38. ItemIDs are usually 9 to 12 digits). |
| OrderLineItemID | string | Optional |
OrderLineItemID is a unique identifier for an eBay order line item and is based upon the concatenation of ItemID and TransactionID, with a hyphen in between these two IDs. 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. Max length: 100. |
| 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. For most Trading API calls, the maximum value is 200 and the default value is 25 entries per page. For GetOrders, the maximum value is 100 and the default value is 25 orders per page. For GetUserDisputes, this value is hard-coded at 200, and any pagination input is ignored. For GetProducts, the maximum value is 20, and any higher values are ignored. |
| 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. Min: 1. Default: 1. |
| TransactionID | string | Optional |
Unique identifier for an eBay order line item (transaction). 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. Max length: 19 (Note: The eBay database specifies 38. TransactionIDs 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. |
| 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 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 |
| 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 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. |
| 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:
|
| 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. |
| Input Detail Controls Samples Change History Top Errors for GetFeedback User Notes |
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 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).
<?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>
<FeedbackResponse> string </FeedbackResponse>
<FeedbackRevised> boolean </FeedbackRevised>
<Followup> string </Followup>
<FollowUpReplaced> boolean </FollowUpReplaced>
<ItemID> ItemIDType (string) </ItemID>
<ItemPrice> 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 | 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 or order line item 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 | Conditionally,
repeatable: [0..*] |
Contains a single feedback detail entry. Output only.
DetailLevel: ReturnAll. |
|
FeedbackDetailArray .FeedbackDetail.CommentingUser |
UserIDType (string) | Conditionally |
The eBay User ID of the user who left the feedback.
DetailLevel: ReturnAll. |
|
FeedbackDetailArray .FeedbackDetail .CommentingUserScore |
int | Conditionally |
The Feedback score of the user indicated in CommentingUser.
DetailLevel: ReturnAll. |
|
FeedbackDetailArray .FeedbackDetail .CommentReplaced |
boolean | Conditionally |
Flag used to indicate whether or not eBay replaced the Feedback comment with a message that the Feedback comment was removed.
DetailLevel: ReturnAll. |
|
FeedbackDetailArray .FeedbackDetail.CommentText |
string | Conditionally |
Textual comment that explains, clarifies, or justifies the Feedback rating specified in CommentType. 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: 80 (125 for Taiwan). DetailLevel: ReturnAll. |
|
FeedbackDetailArray .FeedbackDetail.CommentTime |
dateTime | Conditionally |
Timestamp (in GMT) indicating 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 by CommentingUser. 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: • CustomCode (in/out) This value is reserved for internal or future use. • IndependentlyWithdrawn (in/out) This value indicates that a submitted Feedback entry was withdrawn based on the decision of a third-party (such as eBay). If a Feedback entry is withdrawn, the effect of that entry on the overall Feedback score is nullified. • Negative (in/out) This value indicates that the submitting user's experience with the other user (receiving feedback) was rated as a "Negative" experience. If an eBay user receives a Negative rating for an order line item from a Verified User, their overall Feedback score decreases by a value of 1. • Neutral (in/out) This value indicates that the submitting user's experience with the other user (receiving feedback) was rated as a "Neutral" experience. If an eBay user receives a Neutral rating for an order line item from a Verified User, their overall Feedback score remains the same. • Positive (in/out) This value indicates that the submitting user's experience with the other user (receiving feedback) was rated as a "Positive" experience. If an eBay user receives a Positive rating for an order line item from a Verified User, their overall Feedback score increases by a value of 1. • Withdrawn (in/out) This value indicates that a submitted Feedback entry was withdrawn. If a Feedback entry is withdrawn, the effect of that entry on the overall Feedback score is nullified. However, Feedback comments from the withdrawn entry are still visible. DetailLevel: ReturnAll. |
|
FeedbackDetailArray .FeedbackDetail.Countable |
boolean | Conditionally |
The flag 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. Returned for a detail level of ReturnAll (if the parent is returned).
DetailLevel: ReturnAll. |
|
FeedbackDetailArray .FeedbackDetail .FeedbackResponse |
string | Conditionally |
Textual 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: 80 (125 for Taiwan). DetailLevel: ReturnAll. |
|
FeedbackDetailArray .FeedbackDetail .FeedbackRevised |
boolean | Conditionally |
Flag used to indicate whether or not a Feedback entry was revised (rating was changed).
DetailLevel: ReturnAll. |
|
FeedbackDetailArray .FeedbackDetail.Followup |
string | Conditionally |
Explanation a user can give to a response. Follow-ups to Feedback comments cannot be submitted or edited via the API. Max length: 80 (125 for Taiwan). DetailLevel: ReturnAll. |
|
FeedbackDetailArray .FeedbackDetail .FollowUpReplaced |
boolean | Conditionally |
Flag used to indicate 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 that uniquely identifies the item listing. Max length: 19 (Note: The eBay database specifies 38. ItemIDs 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. |
|
FeedbackDetailArray .FeedbackDetail.ItemTitle |
string | Conditionally |
Name of the item 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: 80. DetailLevel: ReturnAll. |
|
FeedbackDetailArray .FeedbackDetail .OrderLineItemID |
string | Conditionally |
OrderLineItemID is a unique identifier for an eBay order line item and is based upon the concatenation of ItemID and TransactionID, with a hyphen in between these two IDs. Max length: 50 (Note: ItemIDs and TransactionIDs usually consist of 9 to 12 digits.). DetailLevel: ReturnAll. |
|
FeedbackDetailArray .FeedbackDetail .ResponseReplaced |
boolean | Conditionally |
Flag used to indicate 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: • Buyer (in/out) The eBay user is acting as the buyer for the order(s). In GetOrders, this value should be passed into the OrderRole field in the request to retrieve orders in which the calling eBay user is the buyer in the order. • CustomCode (in/out) This value is reserved for future or internal use. • Seller (in/out) The eBay user is acting as the seller for the order(s). In GetOrders, this value should be passed into the OrderRole field in the request to retrieve orders in which the calling eBay user is the seller in the order. 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. Max length: 19 (Note: The eBay database specifies 38. TransactionIDs 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 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 |
Count of the feedback entries 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 feedback entries 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 | 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 |
Count of the feedback entries 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 feedback entries 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 | 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 |
Count of the feedback entries 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 feedback entries 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 | 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 |
Count of the feedback entries 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 feedback entries 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. |
|
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. 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 |
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 |
Count of the feedback entries 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 feedback entries 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 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 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 |
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.
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. See the "Errors by Number" document. |
| 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 | 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 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 "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. |
| Input Output Samples Change History Top Errors for GetFeedback User Notes |
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 Top Errors for GetFeedback User Notes |
New to making API calls? Please see Routing the Request.
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
Bountiful Buyer found a book she wants to buy from Magical Bookseller 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 (HTTP POST). Also available is the .txt version of this XML. <?xml version="1.0" encoding="utf-8"?> <GetFeedbackRequest xmlns="urn:ebay:apis:eBLBaseComponents"> <RequesterCredentials> <eBayAuthToken>ABC...123</eBayAuthToken> </RequesterCredentials> <UserID>magicalbookseller</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, Bountiful Buyer sees that Magical Bookseller 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. Also available is the .txt version of this XML. <GetFeedbackResponse xmlns="urn:ebay:apis:eBLBaseComponents"> <Timestamp>2010-02-10T23:49:56.873Z</Timestamp> <Ack>Success</Ack> <Version>655</Version> <Build>E655_CORE_BUNDLED_10639415_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>979</Count> </FeedbackPeriod> <FeedbackPeriod> <PeriodInDays>30</PeriodInDays> <Count>8</Count> </FeedbackPeriod> <FeedbackPeriod> <PeriodInDays>180</PeriodInDays> <Count>49</Count> </FeedbackPeriod> <FeedbackPeriod> <PeriodInDays>365</PeriodInDays> <Count>109</Count> </FeedbackPeriod> </NegativeFeedbackPeriodArray> <NeutralFeedbackPeriodArray> <FeedbackPeriod> <PeriodInDays>0</PeriodInDays> <Count>1435</Count> </FeedbackPeriod> <FeedbackPeriod> <PeriodInDays>30</PeriodInDays> <Count>10</Count> </FeedbackPeriod> <FeedbackPeriod> <PeriodInDays>180</PeriodInDays> <Count>49</Count> </FeedbackPeriod> <FeedbackPeriod> <PeriodInDays>365</PeriodInDays> <Count>103</Count> </FeedbackPeriod> </NeutralFeedbackPeriodArray> <PositiveFeedbackPeriodArray> <FeedbackPeriod> <PeriodInDays>0</PeriodInDays> <Count>288754</Count> </FeedbackPeriod> <FeedbackPeriod> <PeriodInDays>30</PeriodInDays> <Count>2225</Count> </FeedbackPeriod> <FeedbackPeriod> <PeriodInDays>180</PeriodInDays> <Count>13729</Count> </FeedbackPeriod> <FeedbackPeriod> <PeriodInDays>365</PeriodInDays> <Count>27966</Count> </FeedbackPeriod> </PositiveFeedbackPeriodArray> <TotalFeedbackPeriodArray> <FeedbackPeriod> <PeriodInDays>30</PeriodInDays> <Count>2243</Count> </FeedbackPeriod> <FeedbackPeriod> <PeriodInDays>180</PeriodInDays> <Count>13827</Count> </FeedbackPeriod> <FeedbackPeriod> <PeriodInDays>365</PeriodInDays> <Count>28178</Count> </FeedbackPeriod> </TotalFeedbackPeriodArray> <NeutralCommentCountFromSuspendedUsers>0</NeutralCommentCountFromSuspendedUsers> <UniqueNegativeFeedbackCount>897</UniqueNegativeFeedbackCount> <UniquePositiveFeedbackCount>240063</UniquePositiveFeedbackCount> <UniqueNeutralFeedbackCount>1363</UniqueNeutralFeedbackCount> <SellerRatingSummaryArray> <AverageRatingSummary> <FeedbackSummaryPeriod>FiftyTwoWeeks</FeedbackSummaryPeriod> <AverageRatingDetails> <RatingDetail>ItemAsDescribed</RatingDetail> <Rating>4.9</Rating> <RatingCount>20032</RatingCount> </AverageRatingDetails> <AverageRatingDetails> <RatingDetail>Communication</RatingDetail> <Rating>4.9</Rating> <RatingCount>20006</RatingCount> </AverageRatingDetails> <AverageRatingDetails> <RatingDetail>ShippingTime</RatingDetail> <Rating>4.9</Rating> <RatingCount>19962</RatingCount> </AverageRatingDetails> <AverageRatingDetails> <RatingDetail>ShippingAndHandlingCharges</RatingDetail> <Rating>4.7</Rating> <RatingCount>19959</RatingCount> </AverageRatingDetails> </AverageRatingSummary> <AverageRatingSummary> <FeedbackSummaryPeriod>ThirtyDays</FeedbackSummaryPeriod> <AverageRatingDetails> <RatingDetail>ItemAsDescribed</RatingDetail> <Rating>4.9</Rating> <RatingCount>1522</RatingCount> </AverageRatingDetails> <AverageRatingDetails> <RatingDetail>Communication</RatingDetail> <Rating>4.9</Rating> <RatingCount>1521</RatingCount> </AverageRatingDetails> <AverageRatingDetails> <RatingDetail>ShippingTime</RatingDetail> <Rating>4.9</Rating> <RatingCount>1509</RatingCount> </AverageRatingDetails> <AverageRatingDetails> <RatingDetail>ShippingAndHandlingCharges</RatingDetail> <Rating>4.7</Rating> <RatingCount>1516</RatingCount> </AverageRatingDetails> </AverageRatingSummary> </SellerRatingSummaryArray> <SellerRoleMetrics> <PositiveFeedbackLeftCount>38943</PositiveFeedbackLeftCount> <NegativeFeedbackLeftCount>0</NegativeFeedbackLeftCount> <NeutralFeedbackLeftCount>0</NeutralFeedbackLeftCount> <FeedbackLeftPercent>89.8</FeedbackLeftPercent> <RepeatBuyerCount>0</RepeatBuyerCount> <RepeatBuyerPercent>0.0</RepeatBuyerPercent> <UniqueBuyerCount>0</UniqueBuyerCount> <TransactionPercent>100.0</TransactionPercent> <CrossBorderTransactionCount>4053</CrossBorderTransactionCount> <CrossBorderTransactionPercent>9.3</CrossBorderTransactionPercent> </SellerRoleMetrics> <BuyerRoleMetrics> <PositiveFeedbackLeftCount>0</PositiveFeedbackLeftCount> <NegativeFeedbackLeftCount>0</NegativeFeedbackLeftCount> <NeutralFeedbackLeftCount>0</NeutralFeedbackLeftCount> <FeedbackLeftPercent>0.0</FeedbackLeftPercent> </BuyerRoleMetrics> </FeedbackSummary> <FeedbackScore>239182</FeedbackScore> <PaginationResult> <TotalNumberOfPages>0</TotalNumberOfPages> <TotalNumberOfEntries>0</TotalNumberOfEntries> </PaginationResult> <EntriesPerPage>25</EntriesPerPage> <PageNumber>1</PageNumber> </GetFeedbackResponse>
| Input Output Detail Controls Samples Top Errors for GetFeedback User Notes |
| Version | Description |
|---|---|
| 705 2011-01-19 |
|
| 691 2010-10-14 |
|
| 605 2009-02-18 |
|
| 567 2008-05-28 |
|
| 563 2008-04-30 |
|
| 549 2008-01-24 |
|
| 531 2007-09-19 |
|
| 501 2007-02-21 |
|
| 499 2007-02-07 |
|
| 443 2006-01-11 |
|
| 483 2006-10-18 |
|
| 435 2005-11-16 |
|
| Input Output Detail Controls Samples Change History Top Errors for GetFeedback User Notes |
Copyright © 2005–2013 eBay, Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.