Runtime_Product_Review_Insert

Description#

This is a runtime function intended to be called client side to submit a product review. Because this is a runtime (public) function no API key is required.

It inserts 1 review, with its additional field values, for the Product Reviews module. It applies the same validation and prelogic rules as a review submitted with the TGRADD form action, so the Reviews: Form component in mmx-product-details can submit reviews without reloading the page.

This function is provided by the Product Reviews module, so it’s called through Function: Module with Module_Code: tgreviews, not as a top-level Function. See Example Request.

New in 26.03.00.

Request Parameters#

The fld_* and rc_enabled settings are Product Reviews module settings. Each fld_* setting is Required, Optional or Hidden. Required makes its input required; Optional and Hidden both make it optional.

Field errors#

Approval#

A new review’s approved state comes from the module’s auto_apprv setting. With auto-approve off, the review is inserted unapproved and the function still returns success, so a successful response doesn’t mean the review is visible yet.

The module recalculates the product’s stored rating average as part of the insert.

Duplicate Reviews#

A reviewer can submit 1 review per product. Submitting a second review for a product with an email address that already has one returns MOD-SYS-TGR-00180. TGR_Order_ID isn’t part of this check — reusing an order ID doesn’t block a submission on its own.

Prelogic#

The function runs the same prelogic as a review form post, including tgr_prelogic.mvc. Stores use the prelogic to block submissions, allow more than 1 review per reviewer, or override the approval setting.

When the prelogic sets allow_submission to 0, the review isn’t inserted. The function returns MOD-SYS-TGR-00178 with the message in g.TGR_Error, or “Product review is currently unavailable” when g.TGR_Error is empty.

Response Parameters#

On success, the function returns success with no data.

Validation errors use the standard field error format. See Requests and Responses.

Example Request#

{
    "Store_Code": "{{Store_Code}}",
    "Function": "Module",
    "Module_Code": "tgreviews",
    "Module_Function": "Runtime_Product_Review_Insert",
    "Session_Type": "runtime",
    "TGR_Product_Code": "{{Product_Code}}",
    "TGR_Rating": 5,
    "TGR_Notify": false,
    "TGR_Name": "Jane Smith",
    "TGR_Email": "[email protected]",
    "TGR_Location": "San Diego, CA",
    "TGR_Title": "Fits well",
    "TGR_Summary": "True to size and the fabric holds up after washing.",
    "TGR_AdditionalFields": {
        "{{Additional_Field_Code}}": "{{Value}}"
    }
}

Example Response#

{
    "success": 1
}

Error Responses#