CustomerReview

Type: schema

Description

List of reviews posted by the user.

TypeScript Definition

CustomerReview: {{
            readonly id?: string;
            product_id: string;
            readonly product_name?: string;
            readonly product_image_url?: string;
            readonly status?: string;
            rating: number;
            review_text: string;
            /** Format: date-time */
            review_date?: string;
            readonly average_rating?: number;
            tags?: string[];
            readonly images?: {
                readonly blur_url?: string;
                readonly thumbnail_url?: string;
                readonly standard_url?: string;
            }[];
            readonly videos?: {
                readonly cover_image_url?: string;
                readonly video_preview_url?: string;
                " playback"?: {
                    hls?: string;
                    dash?: string;
                };
                readonly duration?: string;
                readonly size?: string;
            }[];
            /** Format: double */
            readonly listing_price?: number;
            /** Format: double */
            readonly selling_price?: number;
            readonly order_number: string;
            /** Format: date-time */
            readonly created_at?: string;
            /** Format: date-time */
            readonly modified_at?: string;
        };
        /** CustomSlabsBasedOnAmount */
}

OpenAPI Schema

{
  "title": "CustomerReview",
  "description": "List of reviews posted by the user.",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/CustomerReview",
    "description": "API reference for the CustomerReview schema"
  },
  "required": [
    "product_id",
    "rating",
    "review_text",
    "order_number"
  ],
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true
    },
    "product_id": {
      "type": "string"
    },
    "product_name": {
      "type": "string",
      "readOnly": true
    },
    "product_image_url": {
      "type": "string",
      "readOnly": true
    },
    "status": {
      "type": "string",
      "readOnly": true
    },
    "rating": {
      "type": "number"
    },
    "review_text": {
      "type": "string"
    },
    "review_date": {
      "type": "string",
      "format": "date-time"
    },
    "average_rating": {
      "type": "number",
      "readOnly": true
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "images": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "blur_url": {
            "type": "string",
            "readOnly": true
          },
          "thumbnail_url": {
            "type": "string",
            "readOnly": true
          },
          "standard_url": {
            "type": "string",
            "readOnly": true
          }
        }
      },
      "readOnly": true
    },
    "videos": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "cover_image_url": {
            "type": "string",
            "readOnly": true
          },
          "video_preview_url": {
            "type": "string",
            "readOnly": true
          },
          " playback": {
            "type": "object",
            "properties": {
              "hls": {
                "type": "string"
              },
              "dash": {
                "type": "string"
              }
            }
          },
          "duration": {
            "type": "string",
            "readOnly": true
          },
          "size": {
            "type": "string",
            "readOnly": true
          }
        }
      },
      "readOnly": true
    },
    "listing_price": {
      "type": "number",
      "format": "double",
      "readOnly": true
    },
    "selling_price": {
      "type": "number",
      "format": "double",
      "readOnly": true
    },
    "order_number": {
      "type": "string",
      "readOnly": true
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "modified_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    }
  }
}

---

Auto-generated from OpenAPI spec and TypeScript definitions