ProductReview

Type: schema

TypeScript Definition

ProductReview: {{
            /**
             * Format: double
             * @description The rating of the product review. Must be in rang 1-5 (multiple of 0.5)
             */
            rating?: $Read<number>;
            /** @description The text for the product review. */
            review_text?: $Read<string>;
            /** @description The name of the reviewer. */
            name?: $Read<string>;
            /**
             * Format: email
             * @description The email of the reviewer. Must be a valid email, or an empty string.
             * @example mr@bees.com
             */
            email?: $Read<string>;
            /**
             * @description Reviews with approved status will be displayed.
             * @enum {string}
             */
            status?: $Read<"approved">;
            /** @default false */
            is_featured: boolean;
            tags?: string[];
            /**
             * Format: date-time
             * @description The ISO 8601 date-time for when review was first submitted or last modified by the original submitter.
             */
            review_date?: $Read<string>;
            /** @description Product review images ordered by display priority. */
            images?: components["schemas"]["ProductImage"][];
            videos?: components["schemas"]["ProductVideo"][];
            /**
             * Format: date-time
             * @description The ISO 8601 date-time for when review is created.
             * @example 2023-05-25T14:15:22Z
             */
            created_at?: $Read<string>;
            /**
             * Format: date-time
             * @description The ISO 8601 date-time for when review was last modified.
             * @example 2023-05-25T14:15:22Z
             */
            modified_at?: $Read<string>;
        };
        /** ProductShipping */
}

Component References

Reference	Resolves To
components["schemas"]["ProductImage"]	ProductImage
components["schemas"]["ProductVideo"]	ProductVideo

OpenAPI Schema

{
  "title": "ProductReview",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/ProductReview",
    "description": "API reference for the ProductReview schema"
  },
  "properties": {
    "rating": {
      "description": "The rating of the product review. Must be in rang 1-5 (multiple of 0.5)",
      "type": "number",
      "format": "double",
      "maximum": 5,
      "minimum": 1,
      "multipleOf": 0.5,
      "readOnly": true
    },
    "review_text": {
      "description": "The text for the product review.",
      "type": "string",
      "readOnly": true
    },
    "name": {
      "description": "The name of the reviewer.",
      "type": "string",
      "readOnly": true
    },
    "email": {
      "description": "The email of the reviewer. Must be a valid email, or an empty string.",
      "type": "string",
      "format": "email",
      "examples": [
        "mr@bees.com"
      ],
      "readOnly": true
    },
    "status": {
      "description": "Reviews with approved status will be displayed.",
      "type": "string",
      "enum": [
        "approved"
      ],
      "readOnly": true
    },
    "is_featured": {
      "type": "boolean",
      "default": false
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "review_date": {
      "description": "The ISO 8601 date-time for when review was first submitted or last modified by the original submitter.",
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "images": {
      "description": "Product review images ordered by display priority.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ProductImage"
      }
    },
    "videos": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ProductVideo"
      }
    },
    "created_at": {
      "description": "The ISO 8601 date-time for when review is created.",
      "type": "string",
      "format": "date-time",
      "examples": [
        "2023-05-25T14:15:22Z"
      ],
      "readOnly": true
    },
    "modified_at": {
      "description": "The ISO 8601 date-time for when review was last modified.",
      "type": "string",
      "format": "date-time",
      "examples": [
        "2023-05-25T14:15:22Z"
      ],
      "readOnly": true
    }
  },
  "examples": []
}

---

Auto-generated from OpenAPI spec and TypeScript definitions