v1

latestOpenAPI 3.0.02026-07-24283460.8 KB

Reviews and Questions

Create a new Product Review

post/product/review/new

Query parameters

storestring required

Your REVIEWS.io public store key

apikeystring

Your REVIEWS.io private api key. This will add additional private data to the API response such as reviewer email addresses.

Request body

skustring required

Product Identifier

namestring required

Reviewers Name

emailstring required

Reviewers email address

ratingstring required

Review rating

order_idstring

Reviewer order reference

reviewstring required

Review comments

tagsstring

Add tag(s) to your review (must be comma-separated)

addressstring

Reviewers location

ip_addressstring

Reviewers IP Address

ratingsobject

Additional sub-ratings on a product review (Quality, Value for Money, etc). Supports multiple formats: ratings[Quality]=4, additional_rating[42]=4 (by ID), or additional_rating JSON. Max 10 sub-ratings per request. When passed by both ID and JSON, the ID format takes priority.

attributeobject

Descriptive metadata about the reviewer/user (Age Range, Skin Type, etc). Supports formats: attribute[7]=Perfect (by ID) or attribute JSON. When passed by both ID and JSON, the ID format takes priority.

Example request

{
  "sku": "PR-123",
  "name": "Mr Reviewer",
  "email": "reviewer@domain.com",
  "rating": "5",
  "order_id": "#12345",
  "review": "Lovely stuff",
  "tags": "tag1,tag2,tag3",
  "address": "Leicester",
  "ip_address": "87.104.113.209",
  "images": [
    {
      "url": "https://domain.com/media/image.png",
      "status": "active"
    }
  ],
  "ratings": {
    "Quality": 4,
    "Value for Money": 5,
    "Delivery": 5
  },
  "attribute": {
    "Age Range": "25-34",
    "Skin Type": "Oily",
    "Fit": "Perfect"
  }
}

Response

object required