WooCommerce · Schema

StoreReview

A customer review on a product.

eCommerceOpen SourceOrdersProductsWordPress

Properties

Name Type Description
id integer Review unique identifier.
date_created string Date the review was submitted.
product_id integer ID of the reviewed product.
reviewer string Reviewer display name.
review string Review text content.
rating integer Star rating from 1 to 5.
verified boolean Whether the reviewer purchased the product.
View JSON Schema on GitHub

JSON Schema

woocommerce-store-api-store-review-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/woocommerce/refs/heads/main/json-schema/woocommerce-store-api-store-review-schema.json",
  "title": "StoreReview",
  "description": "A customer review on a product.",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "Review unique identifier.",
      "example": 1
    },
    "date_created": {
      "type": "string",
      "format": "date-time",
      "description": "Date the review was submitted.",
      "example": "2026-05-03T14:30:00Z"
    },
    "product_id": {
      "type": "integer",
      "description": "ID of the reviewed product.",
      "example": 1
    },
    "reviewer": {
      "type": "string",
      "description": "Reviewer display name.",
      "example": "string-value"
    },
    "review": {
      "type": "string",
      "description": "Review text content.",
      "example": "string-value"
    },
    "rating": {
      "type": "integer",
      "description": "Star rating from 1 to 5.",
      "minimum": 1,
      "maximum": 5,
      "example": 1
    },
    "verified": {
      "type": "boolean",
      "description": "Whether the reviewer purchased the product.",
      "example": true
    }
  }
}