This API Documentation is targeted at developers and can be used to create bespoke solutions. If you are not a developer please see our review collection methods page for easier methods.

Requirements

🌟 Only available on our Plus plan

Don’t meet the requirements with your current plan? Upgrade now to get access.

Instructions ⚙️

Log into your REVIEWS.io account
Go to Integrations >> API

🚨 Important notice 🚨

It is possible that from time to time APIs experience short downtime. For this reason, it is important that you include error handling in your code so that if your server can't connect to our API then it will fail gracefully and your website will still work.

Where to find your REVIEWS.io API Key

Navigation

Navigate to Integrations in your REVIEWS.io dashboard.
Select API from the Integrations library.

Queue Review Invitations

To Queue a Review Invitation your system needs to send a POST Request to our API. The details of this request are outlined below. Your developer should integrate this into your system so that this request is sent automatically for every order. This API endpoint is Flow Compatible, meaning if you have an active Flow, we will queue invitations according to the rules specified.

Method: POST

URL

https://api.reviews.io/invitation

Headers

Field	Type	Description
store	String	`STORE-URL`
apikey	String	`12345678987654321abcdefgfedcba`

Parameters

Field	Type	Description
name	String	Customer's Name
email	String	Customer's Email Address
order_id	String	Customer's Order ID
products	Array	(Optional) Array of Products - See Example Below

Example Request

Headers

{
  "Content-Type": "application/json",
  "store": "Store_URL",
  "apikey": "58307712a251bc2f45d4548162f0ceb8"
}

Body

{
  "name": "Joe Bloggs",
  "email": "test-85@example.com",
  "order_id": 1234,
  "products": [
    {
      "sku": "1234",
      "name": "Test Product 1",
      "image": "http://placehold.it/100x100",
      "pageUrl": "http://www.myshopp.com/product/1"
    },
    {
      "sku": "12345",
      "name": "Test Product 2",
      "image": "http://placehold.it/100x100",
      "pageUrl": "http://www.myshopp.com/product/2"
    }
  ]
}

Retrieve Company Reviews

Your company reviews can be retrieved by sending a HTTP GET Request to the following API URL:

URL: https://api.reviews.io/merchant/reviews?store=STORE-ID

Retrieve Product Reviews

Product reviews can be retrieved by sending a HTTP GET Request to the following API URL.

URL: https://api.reviews.io/product/review?store=STORE-ID&sku=SKU

Review Revision — Not Available via API

It is not possible to generate a 'Revise Your Review' link via the API. Review revision must be initiated from the REVIEWS.io dashboard.

If a customer needs to edit an existing review, use the dashboard method:

Go to Timeline in your REVIEWS.io dashboard
Open the review you want the customer to revise
Click Ask to Revise — this sends the customer an email with a revision link

For full details, see the Revise Review Email Request article.

For full API documentation, please see here

*This link will only be accessible if you are currently using our Plus plan.