Skip to content

CreateReview

Type: schema

Description

Create Product Review model

TypeScript Definition

typescript
CreateReview: {{
            user_id: string;
            order_number: string;
            rating: number;
            review_text?: string;
            images?: string[];
            videos?: string[];
        };
        /** CreateStandardSubscription */
}

OpenAPI Schema

json
{
  "title": "CreateProductReview",
  "description": "Create Product Review model",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/CreateReview",
    "description": "API reference for the CreateReview schema"
  },
  "required": [
    "user_id",
    "order_number",
    "rating"
  ],
  "properties": {
    "user_id": {
      "type": "string"
    },
    "order_number": {
      "type": "string",
      "writeOnly": true
    },
    "rating": {
      "type": "number"
    },
    "review_text": {
      "type": "string"
    },
    "images": {
      "type": "array",
      "items": {
        "type": "string",
        "contentMediaType": "application/octet-stream"
      }
    },
    "videos": {
      "type": "array",
      "items": {
        "type": "string",
        "contentMediaType": "application/octet-stream"
      }
    }
  }
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: