FeedbackRatingTemplateType

acceptableValues

array of FeedbackRatingAcceptableValue

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
  }
]

For other examples, see the Using rating templates section in the Feedback API Overview.

defaultValue

The default value preselected for the rating, if set.

earlyFeedbackMessage

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

enabled

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

maximumCharactersAllowed

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

multiValueRating

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

ratingKey

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.

ratingLabel

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.

ratingValueType

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.

required

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