Feedback API — client.commerce.feedback¶
Version v1.0.0 · base path /commerce/feedback/v1 · async twin: the same methods on
AsyncEbayClient, awaited.
Operations¶
Bases: BaseResource
get_items_awaiting_feedback ¶
get_items_awaiting_feedback(*, filter: str | None = None, limit: int | str | None = None, offset: int | str | None = None, sort: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> commerce_feedback_models.AwaitingFeedbackResponse
get_items_awaiting_feedback(*, filter: str | None = None, limit: int | str | None = None, offset: int | str | None = None, sort: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_items_awaiting_feedback(*, filter: str | None = None, limit: int | str | None = None, offset: int | str | None = None, sort: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> commerce_feedback_models.AwaitingFeedbackResponse | httpx.Response
This method retrieves line items awaiting feedback from the user's order partner. You can refine the results using optional filter query parameters, such as item ID, username, or user role in the transaction. Sorting and pagination features help organize and navigate returned items efficiently. For sellers, only sold items that have not yet received feedback are included.
get_feedback ¶
get_feedback(*, feedback_type: str, user_id: str, feedback_id: str | None = None, filter: str | None = None, limit: int | str | None = None, listing_id: str | None = None, offset: int | str | None = None, order_line_item_id: str | None = None, sort: str | None = None, transaction_id: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> commerce_feedback_models.GetFeedbackResponse
get_feedback(*, feedback_type: str, user_id: str, feedback_id: str | None = None, filter: str | None = None, limit: int | str | None = None, listing_id: str | None = None, offset: int | str | None = None, order_line_item_id: str | None = None, sort: str | None = None, transaction_id: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_feedback(*, feedback_type: str, user_id: str, feedback_id: str | None = None, filter: str | None = None, limit: int | str | None = None, listing_id: str | None = None, offset: int | str | None = None, order_line_item_id: str | None = None, sort: str | None = None, transaction_id: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> commerce_feedback_models.GetFeedbackResponse | httpx.Response
This method enables users to retrieve feedback for any specified user ID and feedback type (sent or received). You can refine the results using optional query parameters such as its feedback ID, listing ID, or order line item ID or by applying one or more filters. Applying filters can narrow results using criteria such as comment type, photos, or topics identified through AI-based analysis.
leave_feedback ¶
leave_feedback(*, body: LeaveFeedbackRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> commerce_feedback_models.LeaveFeedbackResponse
leave_feedback(*, body: LeaveFeedbackRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
leave_feedback(*, body: LeaveFeedbackRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> commerce_feedback_models.LeaveFeedbackResponse | httpx.Response
This method creates and submits feedback to the user's order partner for a line item in the order. For each order, the order partner is the other participant in the transaction, either the buyer or seller, depending on the eBay user associated with the user token.
get_feedback_rating_summary ¶
get_feedback_rating_summary(*, filter: str, user_id: str, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> commerce_feedback_models.GetFeedbackRatingSummaryResponse
get_feedback_rating_summary(*, filter: str, user_id: str, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_feedback_rating_summary(*, filter: str, user_id: str, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> commerce_feedback_models.GetFeedbackRatingSummaryResponse | httpx.Response
This method provides a detailed overview of feedback ratings associated with a user in the eBay marketplace. Specify a user ID and apply filters to retrieve summarized feedback data categorized by rating types and user roles. These returned metrics are aggregated, which offers insight into user experiences and performance.
respond_to_feedback ¶
respond_to_feedback(*, body: RespondToFeedbackRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> dict[str, Any]
respond_to_feedback(*, body: RespondToFeedbackRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
respond_to_feedback(*, body: RespondToFeedbackRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> dict[str, Any] | httpx.Response
This method allows users to respond to feedback provided by the order partner for a specific line item in an order. For each order, the order partner is the other participant in the transaction, either the buyer or seller, depending on the eBay user associated with the user token. This method allows the user to provide additional context or address the order partner's feedback.
Models¶
CommentCommentPeriod ¶
Bases: EbayModel
unit
class-attribute
instance-attribute
¶
unit = Field(None, description='Unit of time for the value . Supported values: DAY or YEAR .')
value
class-attribute
instance-attribute
¶
value = Field(None, description='Value of the time period expressed in the period contained in the unit . Supported values are 30 , 60 , or 365 . See the commentPeriod container for more information.')
ErrorParameter ¶
FeedbackAggregationTypeEnum ¶
FeedbackCommentStateEnum ¶
FeedbackEnteredPeriod ¶
Bases: EbayModel
unit
class-attribute
instance-attribute
¶
unit = Field(None, description="The unit for the feedback entry period's value . Supported value: DAY .")
value
class-attribute
instance-attribute
¶
value = Field(None, description='The value for the feedback entry period, specified in units of unit . Supported values are 7 , 30 , 90 , 180 , or 365 .')
FeedbackMetrics ¶
Bases: EbayModel
metric_name
class-attribute
instance-attribute
¶
metric_name = Field(None, alias='metricName', description='This enumerated value specifies the type of feedback aggregation. For example, AVG would indicate the feedback returned represents the average value of the feedback. See metricValue for the value of the returned feedback.')
metric_value
class-attribute
instance-attribute
¶
metric_value = Field(None, alias='metricValue', description='The decimal value of the specified metric. For example, 55.8 would represent a value associated with the metricName (see metricName for interpretation and units).')
FeedbackRatingAcceptableValue ¶
Bases: EbayModel
enabled
class-attribute
instance-attribute
¶
enabled = Field(None, description='If true , this boolean indicates that this value is enabled and selectable.')
value
class-attribute
instance-attribute
¶
value = Field(None, description='The value that can be selected for feedback. For most ratingType values, this is 1 through 5 , with 1 representing the lowest rating and 5 representing the highest rating. For ratingType of OVERALL_EXPERIENCE , this can be POSITIVE , NEGATIVE , and NEUTRAL . These are the same values as used with the leaveFeedback methods.')
value_label
class-attribute
instance-attribute
¶
value_label = Field(None, alias='valueLabel', description='This field provides information about the corresponding value .')
FeedbackRatingTypeEnum ¶
Bases: OpenStrEnum
overall_experience_comment
class-attribute
instance-attribute
¶
overall_experience_comment = 'OVERALL_EXPERIENCE_COMMENT'
dsr_item_as_described
class-attribute
instance-attribute
¶
dsr_item_as_described = 'DSR_ITEM_AS_DESCRIBED'
dsr_shipping_charges
class-attribute
instance-attribute
¶
dsr_shipping_charges = 'DSR_SHIPPING_CHARGES'
FeedbackRatingValueDistribution ¶
Bases: EbayModel
count
class-attribute
instance-attribute
¶
count = Field(None, description='An integer representing the number of occurrences for a specific feedback rating value . For example, for the POSITIVE value , a 3 returned as the count represents three positive ratings were returned.')
value
class-attribute
instance-attribute
¶
value = Field(None, description='A string indicating the specific feedback rating value. Supported values include POSITIVE , NEUTRAL , NEGATIVE , 1 , 2 , 3 , 4 , and 5 .')
FeedbackRatingValueTypeEnum ¶
FeedbackRatingValuesEnum ¶
FeedbackStarTypeEnum ¶
Bases: OpenStrEnum
yellow_shooting_star
class-attribute
instance-attribute
¶
yellow_shooting_star = 'YELLOW_SHOOTING_STAR'
turquoise_shooting_star
class-attribute
instance-attribute
¶
turquoise_shooting_star = 'TURQUOISE_SHOOTING_STAR'
purple_shooting_star
class-attribute
instance-attribute
¶
purple_shooting_star = 'PURPLE_SHOOTING_STAR'
green_shooting_star
class-attribute
instance-attribute
¶
green_shooting_star = 'GREEN_SHOOTING_STAR'
silver_shooting_star
class-attribute
instance-attribute
¶
silver_shooting_star = 'SILVER_SHOOTING_STAR'
FeedbackStateEnum ¶
Bases: OpenStrEnum
revision_declined_or_expired
class-attribute
instance-attribute
¶
revision_declined_or_expired = 'REVISION_DECLINED_OR_EXPIRED'
Image ¶
Bases: EbayModel
url
class-attribute
instance-attribute
¶
url = Field(None, description='This field provides the URL of an attached image and is included in the response whenever an image is attached to the feedback.')
ItemsAwaitingFeedbackCount ¶
Bases: EbayModel
as_buyer
class-attribute
instance-attribute
¶
as_buyer = Field(None, alias='asBuyer', description='The number of line items for which feedback is pending from the user in the buyer role.')
as_seller
class-attribute
instance-attribute
¶
as_seller = Field(None, alias='asSeller', description='The number of line items for which feedback is pending from the user in the seller role.')
KeyEnum ¶
Bases: OpenStrEnum
LeaveFeedbackResponse ¶
Bases: EbayModel
feedback_id
class-attribute
instance-attribute
¶
feedback_id = Field(None, alias='feedbackId', description='The unique ID assigned to the submitted feedback.')
ListingPrice ¶
Bases: EbayModel
currency
class-attribute
instance-attribute
¶
currency = Field(None, description='This field provides the three-letter ISO 4217 code that represents the currency of the amount in the value field. Both the value and currency fields are always returned when expressing prices.')
value
class-attribute
instance-attribute
¶
value = Field(None, description='This field contains the numerical value of the listing price in the currency specified in the currency field. Both the value and currency fields are always returned when expressing prices.')
OrderLineItemAttributesEnum ¶
Pagination ¶
Bases: EbayModel
count
class-attribute
instance-attribute
¶
count = Field(None, description='This value indicates the number of feedback entries on the current response page.')
limit
class-attribute
instance-attribute
¶
limit = Field(None, description='The value of the limit parameter submitted in the request. This is the maximum number of line items awaiting feedback, as filtered, to return per page from the result set. This field indicates the number of line items returned per page of data. Note: If this is the last or only page of the result set, the page may contain fewer line items than the limit value.')
next
class-attribute
instance-attribute
¶
next = Field(None, description='The relative URI for the next page of results starting with the resource name. This URI is returned if there is an additional page of results in the result set.')
offset
class-attribute
instance-attribute
¶
offset = Field(None, description='The value of the offset parameter submitted in the request. This field indicates how many results were skipped in the response. If an offset parameter was not included in the request, this value will default to 0 , returning the first page of results. Default: 0')
prev
class-attribute
instance-attribute
¶
prev = Field(None, description='The relative URI for the previous page of results starting with the resource name. This URI is returned if there is a previous page of results in the result set.')
total
class-attribute
instance-attribute
¶
total = Field(None, description='The total number of line items available that match the filter criteria. Note: If the total value exceeds the limit value, there are multiple pages of results.')
Period ¶
Bases: EbayModel
ResponseTypeEnum ¶
SellerRating ¶
Bases: EbayModel
key
class-attribute
instance-attribute
¶
key = Field(None, description='The enumerated value of the category being rated, such as delivery timeliness ( ON_TIME_DELIVERY ).')
value
class-attribute
instance-attribute
¶
value = Field(None, description='The value assigned for the selected category. Use a value of 1 through 5 , with 1 being the lowest rating and 5 being the highest.')
ThresholdTypeEnum ¶
Topic ¶
Bases: EbayModel
coarse_topic
class-attribute
instance-attribute
¶
coarse_topic = Field(None, alias='coarseTopic', description='The main topic (or category) detected in the comment. See the available topics in the filter query parameter.')
fine_topic
class-attribute
instance-attribute
¶
fine_topic = Field(None, alias='fineTopic', description='Note: Fine topics are not currently supported. A more specific detail or subtopic related to the coarse topic.')
highlighted_texts
class-attribute
instance-attribute
¶
highlighted_texts = Field(None, alias='highlightedTexts', description='This array lists any text snippets, phrases, or examples from the feedback that supports the detected topic.')
sentiment
class-attribute
instance-attribute
¶
sentiment = Field(None, description='This field indicates a classification of the feedback, whether the feedback is Positive , Negative , or Neutral .')
TransactionPeriod ¶
Bases: EbayModel
period
class-attribute
instance-attribute
¶
period = Field(None, description='This container indicates if the time since the item was bought on eBay is less than, more than, or equal to 90 days.')
threshold_type
class-attribute
instance-attribute
¶
threshold_type = Field(None, alias='thresholdType', description='This enumerated value indicates whether a transaction period exceeds, falls short, or matches the threshold. You can use this field to trigger specific logic or actions based on whether a transaction period exceeds, falls short, or matches the threshold.')
UserAttributeEnum ¶
UserRoleEnum ¶
Comment ¶
Bases: EbayModel
comment_period
class-attribute
instance-attribute
¶
comment_period = Field(None, alias='commentPeriod', description='This container indicates the timing of a feedback comment based on when it was left. It is only returned if a comment was provided. Possible values are 30 days, 90 days, 180 days, 365 days, or 5 years: Less than 30 days: 30 DAY Over 30 but less than 90 days: 90 DAY Over 90 but less than 180 days: 180 DAY Over 180 but less than 365 days: 365 DAY More than 365 days: 5 YEAR')
comment_text
class-attribute
instance-attribute
¶
comment_text = Field(None, alias='commentText', description="The text of the feedback comment, follow-up, or reply. HTML formatting and personal information (for example, phone numbers) are not allowed. This field is returned if a comment was provided for the feedback entry. If the comment was removed due to eBay policy, this field will contain ' -- ' and the commentTextRemovedPerPolicy field will return true .")
comment_text_removed_per_policy
class-attribute
instance-attribute
¶
comment_text_removed_per_policy = Field(None, alias='commentTextRemovedPerPolicy', description='If true , this boolean indicates the feedback follow-up or reply comment text was removed per eBay policy. This field is only returned when a followupComment container is returned.')
state
class-attribute
instance-attribute
¶
state = Field(None, description='This enumerated value indicates the state of the feedback (for example, ENTERED ). This can be the state of the feedback comment, the follow-up comment, or the reply comment.')
Error ¶
Bases: EbayModel
category
class-attribute
instance-attribute
¶
category = Field(None, description='Identifies the type of erro.')
domain
class-attribute
instance-attribute
¶
domain = Field(None, description='Name for the primary system where the error occurred. This is relevant for application errors.')
error_id
class-attribute
instance-attribute
¶
error_id = Field(None, alias='errorId', description='A unique number to identify the error.')
input_ref_ids
class-attribute
instance-attribute
¶
input_ref_ids = Field(None, alias='inputRefIds', description='An array of request elements most closely associated to the error.')
long_message
class-attribute
instance-attribute
¶
long_message = Field(None, alias='longMessage', description='A more detailed explanation of the error.')
message
class-attribute
instance-attribute
¶
message = Field(None, description="Information on how to correct the problem, in the end user's terms and language where applicable.")
output_ref_ids
class-attribute
instance-attribute
¶
output_ref_ids = Field(None, alias='outputRefIds', description='An array of request elements most closely associated to the error.')
parameters
class-attribute
instance-attribute
¶
parameters = Field(None, description='An array of name/value pairs that describe details the error condition. These are useful when multiple errors are returned.')
subdomain
class-attribute
instance-attribute
¶
subdomain = Field(None, description='Further helps indicate which subsystem the error is coming from. System subcategories include: Initialization, Serialization, Security, Monitoring, Rate Limiting, etc.')
FeedbackRating ¶
Bases: EbayModel
rating_type
class-attribute
instance-attribute
¶
rating_type = Field(None, alias='ratingType', description='This enumerated value indicates the type of rating (for example, OVERALL_EXPERIENCE , DSR_ITEM_AS_DESCRIBED ).')
value
class-attribute
instance-attribute
¶
value = Field(None, description='The value assigned to the rating, specified as a string representing a number from 1 to 5 , with 1 representing the lowest rating and 5 representing the highest rating.')
FeedbackRatingTemplateType ¶
Bases: EbayModel
acceptable_values
class-attribute
instance-attribute
¶
acceptable_values = Field(None, alias='acceptableValues', description='This array contains a list of available values for use in a particular rating and whether the value is enabled. This is provided if ratingValueType is RANGE or PREDEFINED .')
default_value
class-attribute
instance-attribute
¶
default_value = Field(None, alias='defaultValue', description='The default value preselected for the rating, if set.')
early_feedback_message
class-attribute
instance-attribute
¶
early_feedback_message = Field(None, alias='earlyFeedbackMessage', description='For eligible sellers, a message may be shown requiring a wait period before you can leave neutral or negative feedback.')
enabled
class-attribute
instance-attribute
¶
enabled = Field(None, description='If returned as true , this boolean indicates that the corresponding feedback rating template is enabled for the user to provide feedback for this line item. This value will generally be true when the user role is a buyer, but false when the user role is a seller because buyers do not have Detailed Seller Ratings (DSRs).')
maximum_characters_allowed
class-attribute
instance-attribute
¶
maximum_characters_allowed = Field(None, alias='maximumCharactersAllowed', description='The maximum number of characters allowed to be used for a rating that uses freetext. It is only applicable for a rating whose ratingValueType is FREETEXT . Maximum: 500')
multi_value_rating
class-attribute
instance-attribute
¶
multi_value_rating = Field(None, alias='multiValueRating', description='If returned as true , multiple values can be specified for the rating.')
rating_key
class-attribute
instance-attribute
¶
rating_key = Field(None, alias='ratingKey', description='This enumerated value indicates the type of rating that is tracked for the seller. All of the metadata returned under each node for the ratingTemplates array will apply to this rating type. For example, the value OVERALL_EXPERIENCE indicates the rating is for the overall transaction experience.')
rating_label
class-attribute
instance-attribute
¶
rating_label = Field(None, alias='ratingLabel', description='This field provides more details about and/or provides guidance on the corresponding rating type. For example, the rating label of Rate this transaction describes the feedback for the user to enter for an OVERALL_EXPERIENCE ratingKey .')
rating_value_type
class-attribute
instance-attribute
¶
rating_value_type = Field(None, alias='ratingValueType', description='This enumerated value indicates the type of data used to provide the specific feedback rating. If PREDEFINED or RANGE is returned, more information on the supported values will be returned under the acceptableValues array. If FREETEXT is returned, the maximum number of characters supported can be seen in the maximumCharactersAllowed field.')
required
class-attribute
instance-attribute
¶
required = Field(None, description='If returned as true , this rating type is required when leaving feedback.')
LeaveFeedbackRequest ¶
Bases: EbayModel
comment_text
class-attribute
instance-attribute
¶
comment_text = Field(None, alias='commentText', description='Use this field to provide the feedback left by the user, describing their experience with the line item of the transaction. No HTML formatting or personal information (such as phone numbers) is permitted. Maximum length: 500 characters')
comment_type
class-attribute
instance-attribute
¶
comment_type = Field(None, alias='commentType', description='Set this enumerated value to indicate the overall rating of the transaction: POSITIVE , NEUTRAL , or NEGATIVE . Note: Sellers can only provide positive feedback.')
images
class-attribute
instance-attribute
¶
images = Field(None, description='Use this array to optionally list up to 5 images attached to the feedback.')
listing_id
class-attribute
instance-attribute
¶
listing_id = Field(None, alias='listingId', description='Use this field to provide the listing ID related to the transaction.')
order_line_item_id
class-attribute
instance-attribute
¶
order_line_item_id = Field(None, alias='orderLineItemId', description='Use this field to provide the unique identifier of the line item for this feedback.')
seller_ratings
class-attribute
instance-attribute
¶
seller_ratings = Field(None, alias='sellerRatings', description="Use this array to list ratings for specific aspects of the seller's performance.")
transaction_id
class-attribute
instance-attribute
¶
transaction_id = Field(None, alias='transactionId', description='Use this field to provide the unique identifier of the transaction for this feedback.')
OrderLineItemAttribute ¶
Bases: EbayModel
name
class-attribute
instance-attribute
¶
name = Field(None, description='This enumerated value indicates an attribute of the line item. The value field indicates if the attribute applies.')
value
class-attribute
instance-attribute
¶
value = Field(None, description='If returned as true , the line item attribute name applies; if returned as false , the attribute does not apply.')
OrderLineItemSummary ¶
Bases: EbayModel
listing_id
class-attribute
instance-attribute
¶
listing_id = Field(None, alias='listingId', description='This field provides the unique identifier for the listing associated with the feedback entry. It is conditionally returned based on the authorization flow and user context. See orderLineItemSummary for details on when this field is included.')
listing_price
class-attribute
instance-attribute
¶
listing_price = Field(None, alias='listingPrice', description='This container provides the sale price of the listing. It is conditionally returned based on the authorization flow and user context. See orderLineItemSummary for details on when this field is included.')
listing_title
class-attribute
instance-attribute
¶
listing_title = Field(None, alias='listingTitle', description='This field contains the title of the listing. It is conditionally returned based on the authorization flow and user context. See orderLineItemSummary for details on when this field is included.')
order_line_item_attributes
class-attribute
instance-attribute
¶
order_line_item_attributes = Field(None, alias='orderLineItemAttributes', description='This array describes order line attributes including names and values of a transaction.')
order_line_item_id
class-attribute
instance-attribute
¶
order_line_item_id = Field(None, alias='orderLineItemId', description='The unique identifier of the line item for this feedback. It is conditionally returned based on the authorization flow and user context. See orderLineItemSummary for details on when this field is included.')
transaction_period
class-attribute
instance-attribute
¶
transaction_period = Field(None, alias='transactionPeriod', description='This container indicates if the time since the item was bought on eBay is less than, more than, or equal to 90 days')
ProviderUserDetailUserAttributes ¶
Bases: EbayModel
name
class-attribute
instance-attribute
¶
name = Field(None, description='This enumerated value indicates an attribute of the user (for example, USER_VERIFIED ). The value field indicates if the attribute applies.')
value
class-attribute
instance-attribute
¶
value = Field(None, description='If returned as true , the user attribute name applies; if returned as false , the attribute does not apply.')
RatingSummaryByRatingType ¶
Bases: EbayModel
feedback_metrics
class-attribute
instance-attribute
¶
feedback_metrics = Field(None, alias='feedbackMetrics', description='An array of metrics associated with feedback aggregation.')
feedback_rating_value_distribution
class-attribute
instance-attribute
¶
feedback_rating_value_distribution = Field(None, alias='feedbackRatingValueDistribution', description='An array listing the distribution values of the feedback ratings.')
period
class-attribute
instance-attribute
¶
period = Field(None, description='The time period on which the feedback summary is calculated.')
user_role_type
class-attribute
instance-attribute
¶
user_role_type = Field(None, alias='userRoleType', description="This enumerated value indicates the user's role in the feedback ( BUYER or SELLER ).")
RespondToFeedbackRequest ¶
Bases: EbayModel
feedback_id
class-attribute
instance-attribute
¶
feedback_id = Field(None, alias='feedbackId', description='Use this field to provide the unique identifier for the feedback being responded to. It is used to specify the feedback entry associated with the feedback response. This value can be returned using the getFeedback method (strong>feedbackId field).')
recipient_user_id
class-attribute
instance-attribute
¶
recipient_user_id = Field(None, alias='recipientUserId', description='Use this field to provide the identifier of the user who provided the original feedback. This value can be returned using the getFeedback method ( userId field). Note: Both usernames and public user IDs will be accepted in this field. For more information, please refer to Data Handling Compliance .')
response_text
class-attribute
instance-attribute
¶
response_text = Field(None, alias='responseText', description='Use this field to provide the text content of the response. This field is used to provide additional context or address the feedback given by the order partner. No HTML formatting or personal information (such as phone numbers) is permitted. Maximum length: 500 characters.')
response_type
class-attribute
instance-attribute
¶
response_type = Field(None, alias='responseType', description='Set this enumerated value to describe the type of response being submitted (for example, a REPLY or a FOLLOW_UP ).')
AwaitingFeedback ¶
Bases: EbayModel
listing_id
class-attribute
instance-attribute
¶
listing_id = Field(None, alias='listingId', description='This is the unique identifier for the listing associated with the line item. It is used to reference the specific listing that is awaiting feedback.')
listing_price
class-attribute
instance-attribute
¶
listing_price = Field(None, alias='listingPrice', description='This container shows the sale price of the listing.')
listing_title
class-attribute
instance-attribute
¶
listing_title = Field(None, alias='listingTitle', description='The title of the listing.')
order_line_item_id
class-attribute
instance-attribute
¶
order_line_item_id = Field(None, alias='orderLineItemId', description='The unique identifier for the eBay order line item associated with the listing. It is used to pinpoint the exact line item awaiting feedback.')
rating_templates
class-attribute
instance-attribute
¶
rating_templates = Field(None, alias='ratingTemplates', description="This array contains a list of available values for use in a particular rating as well as whether the value is enabled. This is dependent on what seller ratings the buyer's order partner qualifies. Note: Rating templates should only be returned to the user in their role as a buyer; only sellers have Detailed Seller Ratings (DSRs).")
transaction_id
class-attribute
instance-attribute
¶
transaction_id = Field(None, alias='transactionId', description='The unique identifier of the sales transaction.')
AwaitingFeedbackResponse ¶
Bases: EbayModel
items_awaiting_feedback_count
class-attribute
instance-attribute
¶
items_awaiting_feedback_count = Field(None, alias='itemsAwaitingFeedbackCount', description='This container returns the number of line items awaiting feedback. The asSeller and asBuyer fields return the total count of items awaiting feedback as seller and buyer and are not affected by the userRole filter.')
line_items
class-attribute
instance-attribute
¶
line_items = Field(None, alias='lineItems', description='This array contains the details for each line item awaiting feedback. An empty array is returned if no line items are awaiting feedback or that match the filter criteria.')
pagination
class-attribute
instance-attribute
¶
pagination = Field(None, description='This container provides pagination information for the returned line items awaiting feedback (as filtered).')
FeedbackRatingSummary ¶
Bases: EbayModel
rating_summary_by_rating_type
class-attribute
instance-attribute
¶
rating_summary_by_rating_type = Field(None, alias='ratingSummaryByRatingType', description='An array that includes metrics and distributions for each rating type.')
rating_type
class-attribute
instance-attribute
¶
rating_type = Field(None, alias='ratingType', description='This enumerated value indicates the type of rating being summarized. For example, OVERALL_EXPERIENCE indicates the rating applies to the overall transaction experience.')
GetFeedbackRatingSummaryResponse ¶
Bases: EbayModel
feedback_rating_summary
class-attribute
instance-attribute
¶
feedback_rating_summary = Field(None, alias='feedbackRatingSummary', description='An array containing a summary of feedback ratings. Each element provides detailed metrics and distributions for specific rating types.')
ProviderUserDetail ¶
Bases: EbayModel
feedback_score
class-attribute
instance-attribute
¶
feedback_score = Field(None, alias='feedbackScore', description='This integer indicates the feedback score of the feedback provider at the time the specific feedback was left.')
feedback_star
class-attribute
instance-attribute
¶
feedback_star = Field(None, alias='feedbackStar', description='This enumerated value provides the visual star representation of the feedback score (for example, YELLOW_STAR ).')
role
class-attribute
instance-attribute
¶
role = Field(None, description="This enumerated value indicates the user's role in the transaction ( BUYER or SELLER ).")
user_attributes
class-attribute
instance-attribute
¶
user_attributes = Field(None, alias='userAttributes', description='This array lists additional attributes that relate to the user (such as verification status).')
user_id
class-attribute
instance-attribute
¶
user_id = Field(None, alias='userId', description='This field indicates the unique identifier of the user who gave the feedback. Note: Select developers will not receive username data for U.S. users through this field. Instead, an immutable user ID will be returned in its place. For more information, please refer to Data Handling Compliance .')
FeedbackDetail ¶
Bases: EbayModel
automated_feedback
class-attribute
instance-attribute
¶
automated_feedback = Field(None, alias='automatedFeedback', description='If the returned value is true , feedback was generated and added automatically by eBay. If a seller has a feedback score 10 or less, eBay automatically leaves feedback. The buyer can choose to override the eBay feedback and leave feedback of their own. Note: Detailed Seller Ratings (DSRs) are not provided by eBay, only a predefined comment and a positive rating.')
comment_type
class-attribute
instance-attribute
¶
comment_type = Field(None, alias='commentType', description='This enumerated value indicates the type of feedback: POSITIVE , NEUTRAL , NEGATIVE . Note: Sellers can only leave positive feedback for buyers.')
eligible_for_revision
class-attribute
instance-attribute
¶
eligible_for_revision = Field(None, alias='eligibleForRevision', description='This boolean indicates whether the feedback is eligible for revision. If returned as true , it means the feedback can be modified. Feedback that is older than 30 days or has already been revised once cannot be erased or further revised.')
feedback_comment
class-attribute
instance-attribute
¶
feedback_comment = Field(None, alias='feedbackComment', description='This container provides the feedback comment left by a user when submitting feedback for a seller or buyer.')
feedback_entered_date
class-attribute
instance-attribute
¶
feedback_entered_date = Field(None, alias='feedbackEnteredDate', description='The timestamp when the feedback was submitted.')
feedback_entered_period
class-attribute
instance-attribute
¶
feedback_entered_period = Field(None, alias='feedbackEnteredPeriod', description='This container represents the duration since feedback was entered, expressed as a numeric value and a unit of time in days.')
feedback_id
class-attribute
instance-attribute
¶
feedback_id = Field(None, alias='feedbackId', description='The unique identifier of the feedback entry.')
feedback_ratings
class-attribute
instance-attribute
¶
feedback_ratings = Field(None, alias='feedbackRatings', description='This array contains a list of ratings attached to feedback. Note: This array only applies to buyers feedback for sellers (sellers can only give positive feedback to buyers).')
feedback_score
class-attribute
instance-attribute
¶
feedback_score = Field(None, alias='feedbackScore', description="The feedback receiver's feedback score after receiving this specific feedback.")
feedback_state
class-attribute
instance-attribute
¶
feedback_state = Field(None, alias='feedbackState', description='This enumerated value indicates the current state of the feedback entry (for example, ENTERED ).')
followup_comment
class-attribute
instance-attribute
¶
followup_comment = Field(None, alias='followupComment', description='This container provides the details of any follow-up comment left. Note: A buyer leaves follow-up comments and a seller leaves reply comments.')
has_images
class-attribute
instance-attribute
¶
has_images = Field(None, alias='hasImages', description='If returned as true , this boolean indicates that the feedback entry has one or more images attached. If false , there are no images attached.')
images
class-attribute
instance-attribute
¶
images = Field(None, description='This array contains the list of attached images.')
order_line_item_summary
class-attribute
instance-attribute
¶
order_line_item_summary = Field(None, alias='orderLineItemSummary', description='This container provides a summary of the line item associated with the feedback entry. Note: Certain fields within this container are returned only when the request uses the Authorization code grant flow (user access token) and the user_id matches the authenticated user.')
provider_user_detail
class-attribute
instance-attribute
¶
provider_user_detail = Field(None, alias='providerUserDetail', description='This container details the attributes of the user who provided the feedback.')
replied_before_followup
class-attribute
instance-attribute
¶
replied_before_followup = Field(None, alias='repliedBeforeFollowup', description='If returned as true , this boolean indicates the feedback reply was given by the seller before the follow-up comment was given by the buyer.')
reply_comment
class-attribute
instance-attribute
¶
reply_comment = Field(None, alias='replyComment', description='This container provides the details of any reply to the feedback. Note: A buyer leaves follow-up comments and a seller leaves reply comments.')
topics
class-attribute
instance-attribute
¶
topics = Field(None, description='This array provides descriptions of AI-generated insights related to a feedback entry for the specified filter topic. The feedback provided is considered relevant to the requested topic .')
GetFeedbackResponse ¶
Bases: EbayModel
feedback_entries
class-attribute
instance-attribute
¶
feedback_entries = Field(None, alias='feedbackEntries', description='This array contains a list of feedback entries that meet the specified criteria.')
pagination
class-attribute
instance-attribute
¶
pagination = Field(None, description='This container provides pagination information for the returned feedback response (as filtered).')