createProductReview mutation

The createProductReview mutation adds a review for the specified product. Use the productReviewRatingsMetadata query to return a list of rating categories and possible values.

Syntax

createProductReview(input: CreateProductReviewInput!): CreateProductReviewOutput!

Reference

The createProductReview reference provides detailed information about the types and fields defined in this mutation.

Example usage

In the following example, Roni gives product WH08 four stars overall, three stars for value, and four stars for quality.

Request:

Copy
mutation {
  createProductReview(
    input: {
      sku: "WH08",
      nickname: "Roni",
      summary: "Great looking sweatshirt",
      text: "This sweatshirt looks and feels great. The zipper sometimes sticks a bit.",
      ratings: [
        {
          id: "NA==",
          value_id: "MTk="
        }, {
          id: "MQ==",
          value_id: "NA=="
        }, {
          id: "Mg==",
          value_id: "OA=="
        }
      ]
    }
) {
    review {
      nickname
      summary
      text
      average_rating
      ratings_breakdown {
        name
        value
      }
    }
  }
}
Copied to your clipboard
mutation {
  createProductReview(
    input: {
      sku: "WH08",
      nickname: "Roni",
      summary: "Great looking sweatshirt",
      text: "This sweatshirt looks and feels great. The zipper sometimes sticks a bit.",
      ratings: [
        {
          id: "NA==",
          value_id: "MTk="
        }, {
          id: "MQ==",
          value_id: "NA=="
        }, {
          id: "Mg==",
          value_id: "OA=="
        }
      ]
    }
) {
    review {
      nickname
      summary
      text
      average_rating
      ratings_breakdown {
        name
        value
      }
    }
  }
}

Response:

Copy
{
  "data": {
    "createProductReview": {
      "review": {
        "nickname": "Roni",
        "summary": "Great looking sweatshirt",
        "text": "This sweatshirt looks and feels great. The zipper sometimes sticks a bit.",
        "average_rating": 73.33,
        "ratings_breakdown": [
          {
            "name": "Quality",
            "value": "4"
          },
          {
            "name": "Value",
            "value": "3"
          },
          {
            "name": "Overall",
            "value": "4"
          }
        ]
      }
    }
  }
}
Copied to your clipboard
{
  "data": {
    "createProductReview": {
      "review": {
        "nickname": "Roni",
        "summary": "Great looking sweatshirt",
        "text": "This sweatshirt looks and feels great. The zipper sometimes sticks a bit.",
        "average_rating": 73.33,
        "ratings_breakdown": [
          {
            "name": "Quality",
            "value": "4"
          },
          {
            "name": "Value",
            "value": "3"
          },
          {
            "name": "Overall",
            "value": "4"
          }
        ]
      }
    }
  }
}

Errors

Last updated 11/27/2023

Was this helpful?

Yes

No