create-product-review

Method: POST
Path: /catalog/products/{product_id}/reviews

Tags: Catalog

Summary

Create product review

Description

Create a product review

Storefront SDK Usage

SDK Method: sdk.catalog.createProductReview()

Example:

const { data, error } = await sdk.catalog.createProductReview(
  { product_id: "prod_123" },
  {
    rating: 5,
    comment: "Excellent product! Highly recommended.",
    images: [
      new File(["image data"], "review1.jpg", { type: "image/jpeg" }),
      new File(["image data"], "review2.jpg", { type: "image/jpeg" })
    ]
  }
);

if (error) {
  console.error("Failed to create review:", error);
  return;
}

console.log("Review created successfully:", data.message);

TypeScript Definition

"create-product-review": {
        parameters: {
            query?: never;
            header?: never;
            path: {
                /** @description id of a particular product */
                product_id: string;
            };
            cookie?: never;
        };
        requestBody: {
            content: {
                "multipart/form-data": components["schemas"]["CreateReview"];
            };
        };
        responses: {
            /** @description Success response */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": {
                        /** @example Review submitted successfully. */
                        message: string;
                        success: boolean;
                    };
                };
            };
            400: components["responses"]["BadRequest"];
            401: components["responses"]["Unauthorized"];
            404: components["responses"]["NotFound"];
        };
    };

Component References

Reference	Resolves To
components["schemas"]["CreateReview"]	CreateReview
components["responses"]["BadRequest"]	BadRequest
components["responses"]["Unauthorized"]	Unauthorized
components["responses"]["NotFound"]	NotFound

Parameters

• product_id (path): id of a particular product

Request Body

Content Types: multipart/form-data

Responses

200

Success response

400

Bad request

401

Not authorized for given operation on the Resource

404

Requested resource not found

OpenAPI Definition

{
  "tags": [
    "Catalog"
  ],
  "operationId": "create-product-review",
  "summary": "Create product review",
  "description": "Create a product review",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/operations/create-product-review",
    "description": "API reference for the create-product-review operation"
  },
  "parameters": [
    {
      "name": "product_id",
      "in": "path",
      "description": "id of a particular product",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "required": true,
    "content": {
      "multipart/form-data": {
        "schema": {
          "$ref": "#/components/schemas/CreateReview"
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "Success response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "message",
              "success"
            ],
            "properties": {
              "message": {
                "type": "string",
                "examples": [
                  "Review submitted successfully."
                ]
              },
              "success": {
                "type": "boolean"
              }
            }
          }
        }
      }
    },
    "400": {
      "$ref": "#/components/responses/BadRequest"
    },
    "401": {
      "$ref": "#/components/responses/Unauthorized"
    },
    "404": {
      "$ref": "#/components/responses/NotFound"
    }
  },
  "security": [
    {
      "Authorization": []
    }
  ],
  "x-speakeasy-group": "catalog",
  "x-speakeasy-ignore": true,
  "x-speakeasy-name-override": "createProductReview"
}

---

Auto-generated from OpenAPI spec and TypeScript definitions