`IProductFeedbackCreateRequest`

The physical TypeScript declaration from the Nuxt starter, with linked types and field comments.

IProductFeedbackCreateRequest

Send multipart/form-data: data is the JSON object shown in the request; selected files are separate feedback_images parts. Do not set a manual multipart boundary.

src/lib/interfaces/orionplace/products/IProductFeedbackApi.ts

TypeScript

export interface IProductFeedbackCreateRequest {
  // Product ID, required: without it the response is a `for_product` field
  // error. When the store accepts reviews only from buyers, an order containing
  // the product or an option containing it is required. Each accepted call
  // creates a new review; the form does not limit one review per customer and
  // product.
  for_product: number;
  // Required review text, at most 1024 characters, trimmed of surrounding
  // whitespace. The minimum length is `variables.feedback_text_min_length` from
  // Application Load (`0` means no minimum); a shorter text returns the field
  // error “The review must be at least N characters long.” on `text` with code
  // `text_too_short`.
  text: string;
  // A review (without `reply_to`) needs a whole number from 1 to 5 stars. 0 or
  // a missing value returns the field error “Rate the product from 1 to 5
  // stars.” on `rating`; a value outside 0–5 returns a range error on `rating`.
  // A reply (`reply_to` set) does not rate: the value is ignored and saved as
  // 0.
  rating?: number;
  // Optional ID of an approved review or reply on the same product, left in
  // this store group. Omit to create a root review.
  reply_to?: number | null;
}