Skip to content

Write review

Writes or updates the customer's review of a product.

Needs the review:write scope.

Call

  • Tool: write_review
  • Scope: review:write
  • Writes, and may change or remove what is there.
  • Acts on a store.

Arguments

Name Type Required Description
product object Yes
rating integer Yes
notes string or null No
username string or null No
{
  "type": "object",
  "properties": {
    "product": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "minLength": 1,
              "maxLength": 512
            }
          },
          "required": [
            "id"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "slug": {
              "type": "string",
              "minLength": 1,
              "maxLength": 512
            }
          },
          "required": [
            "slug"
          ],
          "additionalProperties": false
        }
      ]
    },
    "rating": {
      "type": "integer",
      "minimum": 1,
      "maximum": 5
    },
    "notes": {
      "anyOf": [
        {
          "type": "string",
          "minLength": 1,
          "maxLength": 4000
        },
        {
          "type": "null"
        }
      ]
    },
    "username": {
      "anyOf": [
        {
          "type": "string",
          "minLength": 1,
          "maxLength": 120
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "product",
    "rating"
  ],
  "additionalProperties": false
}

Answer

Name Type Required Description
mine boolean Yes
hidden_at string or null Yes
id string Yes
product_id string Yes
rating number Yes
username string or null Yes
notes string or null Yes
reply string or null Yes
replied_at string or null Yes
created_at string or null Yes
updated_at string or null Yes When the customer last edited it; null until they do.

The answer’s full shape is on its API reference page.

Type to search…

↑↓ navigate↵ selectEsc close