Submit Review

Post review data to Cloutly. This helps drive more Google/Facebook reviews for your suppliers.

Use this API if you want YOUR SYSTEM to handle the review collection process, and submit the data directly to Cloutly.

Sequence Diagram

POST /vendors/{vendorId}/submit-review

This will add review data for a vendor. The review data will be used in the insights engine and available on review widgets.

• Please remember to add the Product details if this was for a product review.

Request

POST https://marketplace.cloutly.com/api/v2/vendors/{vendorId}/submit-review

{
  "rating": "5", // 1-5 string
  "text": "This product is awesome!",
  "vendorId": "<vendor_id_created_in_first_step>",
  "firstName": "John",
  "lastName": "Smith",
  "channel": {
    "email": "[email protected]",
    "phoneNumber": "4412321321321"
  },
  "source": "my-platform",
  "product": {
      "sourceProductId": "12345",
      "title": "Peroni",
      "description": "A refreshing cold beer.",
      "imageUrl": "https://example.com/beer.png"
  },
  "showOnWidget": true, // flag to hide reviews from review widgets.
}

Response

{
    "feedback": {
        "id": "4a30cd9f-9b0e-486c-a9f8-55c1ee041471",
        "source": "my-platform" // if provided
        ...
    },
}

Notes:

If you have any questions regarding the REST API, feel free to chat with us at any time.