getItemsAwaitingFeedback

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.

Occurrence: Always

The number of line items for which feedback is pending from the user in the buyer role.

Occurrence: Always

The number of line items for which feedback is pending from the user in the seller role.

Occurrence: Always

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.

Occurrence: Always

This is the unique identifier for the listing associated with the line item. It is used to reference the specific listing for which feedback is being awaited.

Occurrence: Always

This container shows the sales price of the listing.

Occurrence: Always

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.

Occurrence: Always

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.

Occurrence: Always

The title of the listing.

Occurrence: Always

The unique identifier for the eBay order line item associated with the listing. It is used to pinpoint the exact line item for which feedback is being awaited.

Occurrence: Always

This array contains a list of available values for use in a particular rating, and 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).

Use the metadata returned here when leaving DSR ratings through the leaveFeedback method. The key field in this container is the ratingKey field. See FeedbackRatingTypeEnum for its values. The other metadata returned in this container apply to each ratingKey value that is returned.

Occurrence: Always

This array contains a list of available values for use in a particular rating, and whether the value is enabled. Provided if ratingValueType is RANGE or PREDEFINED.

The following is an example of a predefined list:

[
  {
    "value": "POSITIVE",
    "valueLabel": "Positive",
    "enabled": true
  },
  {
    "value": "NEUTRAL",
    "valueLabel": "Neutral",
    "enabled": true
  },
  {
    "value": "NEGATIVE",
    "valueLabel": "Negative",
    "enabled": true
  }
]

Occurrence: Conditional

If true, this boolean indicates that this value is enabled and selectable.

Occurrence: Always

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.

Occurrence: Always

This field provides information about the corresponding value.

Occurrence: Always

The default value preselected for the rating, if set.

Occurrence: Conditional

For eligible sellers, a message may be shown requiring a wait period before you can leave neutral or negative feedback.

Occurrence: Conditional

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).

Occurrence: Always

The maximum number of characters allowed to be used for a rating that uses free text. It is only applicable for a rating whose ratingValueType is FREETEXT.

Maximum: 500

Occurrence: Conditional

If returned as true, multiple values can be specified for the rating.

Occurrence: Conditional

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.

Occurrence: Always

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.

Occurrence: Always

This enumerated value indicates the type of data used to provide the specific feedback rating.

If set to PREDEFINED or RANGE, is returned here, more information on the supported values will be returned under the acceptableValues array. If FREETEXT is returned here, the maximum number of characters supported can be seen in the maximumCharactersAllowed field.

Occurrence: Always

If returned as true, this rating type is required when leaving feedback.

Occurrence: Always

The unique identifier of the sales transaction.

Occurrence: Always

This container provides pagination information for the returned line items awaiting feedback (as filtered).

Occurrence: Always

This value indicates the number of feedback entries on the current response page.

Occurrence: Always

The value of the limit parameter submitted in the request. This is the maximum number of line items, as filtered, awaiting feedback 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.

If a limit parameter was not included in the request, this value will default to 25, returning up to 25 line items on each page.

Default: 25

Occurrence: Always

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.

Occurrence: Conditional

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

Occurrence: Always

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.

Occurrence: Conditional

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.

Occurrence: Always