Product Reviews API

Create comment

Create a new comment for a given conversation. The comment is appended to the list of existing comments.

HTTP method: POST

Authentication: Business user OAuth Token

URL: https://api.trustpilot.com/v1/private/conversations/{conversationId}/comments

Parameters
- conversationId, Required string
  
  The ID of the conversation to create a comment for
  
  Example: .../v1/private/conversations/507f191e810c19729de860ea/comments
- CURL
curl -X POST "https://api.trustpilot.com/v1/private/conversations/{conversationId}/comments" \ -H "Content-Type: application/json" \ -d '{ "content": "Thank you for you kind words, we really appreciate it.", "integrationId": "IB2478HFAJKN38" }' \ -H "Authorization: Bearer YOUR-ACCESS-TOKEN"
Request Body
```
{
  "content": "Thank you for you kind words, we really appreciate it.",
  "integrationId": "IB2478HFAJKN38"
}
```
Response
```
{
  "commentId": "507f191e810c19729de860ea",
  "createdAt": "2013-09-07T13:37:00",
  "author": {
    "id": "507f191e810c19729de860ea",
    "type": "businessUser"
  },
  "content": "Thank you for you kind words, we really appreciate it."
}
```
Get conversation

Get a conversation and related comments by id.

HTTP method: GET

Authentication: Business user OAuth Token

URL: https://api.trustpilot.com/v1/private/conversations/{conversationId}

Parameters
- conversationId, Required string
  
  The ID of the conversation to retrieve
  
  Example: .../v1/private/conversations/507f191e810c19729de860ea
- CURL
curl -X GET "https://api.trustpilot.com/v1/private/conversations/{conversationId}" \ -H "Authorization: Bearer YOUR-ACCESS-TOKEN"
Response
```
{
  "id": "507f191e810c19729de860ea",
  "businessUnitId": "507f191e810c19729de860ea",
  "consumerId": "507f191e810c19729de860ea",
  "source": "Product reviews",
  "sourceId": "507f191e810c19729de860ea",
  "state": "public",
  "comments": [
    {
      "commentId": "507f191e810c19729de860ea",
      "createdAt": "2013-09-07T13:37:00",
      "author": {
        "id": "507f191e810c19729de860ea",
        "type": "businessUser"
      },
      "content": "Thank you for you kind words, we really appreciate it."
    }
  ]
}
```
Set conversation state

Set the conversation state to either public or private. If set to private no third parties will see the conversation.

HTTP method: POST

Authentication: Business user OAuth Token

URL: https://api.trustpilot.com/v1/private/conversations/{conversationId}/state

Parameters
- conversationId, Required string
  
  The ID of the conversation to change the state for
  
  Example: .../v1/private/conversations/507f191e810c19729de860ea/state
- CURL
curl -X POST "https://api.trustpilot.com/v1/private/conversations/{conversationId}/state" \ -H "Content-Type: application/json" \ -d '{ "state": "private" }' \ -H "Authorization: Bearer YOUR-ACCESS-TOKEN"
Request Body
```
{
  "state": "private"
}
```
Get comment

Get a single comment by id.

HTTP method: GET

Authentication: Business user OAuth Token

URL: https://api.trustpilot.com/v1/private/conversations/{conversationId}/comments/{commentId}

Parameters
- conversationId, Required string
  
  The ID of the conversation the comment to retrieve is part of
  
  Example: .../v1/private/conversations/507f191e810c19729de860ea/comments/{commentId}
- commentId, Required string
  
  The ID of the comment to retrieve
  
  Example: .../v1/private/conversations/{conversationId}/comments/507f191e810c19729de860ea
- CURL
curl -X GET "https://api.trustpilot.com/v1/private/conversations/{conversationId}/comments/{commentId}" \ -H "Authorization: Bearer YOUR-ACCESS-TOKEN"
Response
```
{
  "commentId": "507f191e810c19729de860ea",
  "createdAt": "2013-09-07T13:37:00",
  "author": {
    "id": "507f191e810c19729de860ea",
    "type": "businessUser"
  },
  "content": "Thank you for you kind words, we really appreciate it."
}
```

Update comment

Edit a single comment by id.

HTTP method: PUT

Authentication: Business user OAuth Token

URL: https://api.trustpilot.com/v1/private/conversations/{conversationId}/comments/{commentId}

Parameters

conversationId, Required string

The ID of the conversation to update a comment for

Example: .../v1/private/conversations/507f191e810c19729de860ea/comments/{commentId}

commentId, Required string

The ID of the comment to update

Example: .../v1/private/conversations/{conversationId}/comments/507f191e810c19729de860ea

CURL

curl -X PUT "https://api.trustpilot.com/v1/private/conversations/{conversationId}/comments/{commentId}" \
  -H "Content-Type: application/json" \
  -d '{
    "content": "Thank you for you kind words, we really appreciate it.",
    "integrationId": "IB2478HFAJKN38"
  }' \
  -H "Authorization: Bearer YOUR-ACCESS-TOKEN"

Request Body

{
  "content": "Thank you for you kind words, we really appreciate it.",
  "integrationId": "IB2478HFAJKN38"
}

Response

{
  "commentId": "507f191e810c19729de860ea",
  "createdAt": "2013-09-07T13:37:00",
  "author": {
    "id": "507f191e810c19729de860ea",
    "type": "businessUser"
  },
  "content": "Thank you for you kind words, we really appreciate it."
}

Get public conversation

Get a public conversation and related comments by id.

HTTP method: GET

Authentication: API Key

URL: https://api.trustpilot.com/v1/conversations/{conversationId}

Parameters

conversationId, Required string

The ID of the conversation to retrieve

Example: .../v1/conversations/507f191e810c19729de860ea

CURL

curl -X GET "https://api.trustpilot.com/v1/conversations/{conversationId}" \
  -H "apikey: YOUR-API-KEY-HERE"

Response

{
  "id": "507f191e810c19729de860ea",
  "businessUnitId": "507f191e810c19729de860ea",
  "consumerId": "507f191e810c19729de860ea",
  "comments": [
    {
      "commentId": "507f191e810c19729de860ea",
      "createdAt": "2013-09-07T13:37:00",
      "author": {
        "id": "507f191e810c19729de860ea",
        "type": "businessUser"
      },
      "content": "Thank you for you kind words, we really appreciate it."
    }
  ]
}

Get product reviews summaries list

Get a list of summaries of product reviews for a business unit. The summary contains information about stars average, distribution and count. Pagination is used to retrieve all results.

HTTP method: GET

Authentication: Business user OAuth Token

URL: https://api.trustpilot.com/v1/private/product-reviews/business-units/{businessUnitId}/summaries

Parameters
- businessUnitId, Required string
  
  The id of the business unit
  
  Example: .../v1/private/product-reviews/business-units/507f191e810c19729de860ea/summaries
- page, Optional integer
  
  The page to retrieve. If the page number requested is higher than the available number of pages an empty array will be returned.
  
  Example: ?page=1
- perPage, Optional integer
  
  The number of summaries to retrieve per page.
  
  Example: ?perPage=3
- CURL
curl -X GET "https://api.trustpilot.com/v1/private/product-reviews/business-units/{businessUnitId}/summaries" \ -H "Authorization: Bearer YOUR-ACCESS-TOKEN"
Response
```
{
  "links": [
    {
      "href": "<Url for the resource>",
      "method": "<Http method for the resource>",
      "rel": "<Description of the relation>"
    }
  ],
  "summaries": [
    {
      "sku": "ABC-1234",
      "starsAverage": 3.1,
      "numberOfReviews": {
        "total": 14,
        "oneStar": 2,
        "twoStars": 3,
        "threeStars": 2,
        "fourStars": 5,
        "fiveStars": 2
      }
    }
  ]
}
```

Get public batch aggregated attribute rating summaries

Get the aggregated attribute ratings for the provided SKUs for the business unit

HTTP method: POST

Authentication: API Key

URL: https://api.trustpilot.com/v1/product-reviews/business-units/{businessUnitId}/attribute-summaries

Parameters

businessUnitId, Required string

The id of the business unit

Example: .../v1/product-reviews/business-units/507f191e810c19729de860ea/attribute-summaries

CURL

curl -X POST "https://api.trustpilot.com/v1/product-reviews/business-units/{businessUnitId}/attribute-summaries" \
  -H "Content-Type: application/json" \
  -d '{
    "skus": [
      "ABCD-1234",
      "ACDC-4321"
    ],
    "locale": "da-DK"
  }' \
  -H "apikey: YOUR-API-KEY-HERE"

Request Body

{
  "skus": [
    "ABCD-1234",
    "ACDC-4321"
  ],
  "locale": "da-DK"
}

Response

{
  "summaries": [
    {
      "sku": null,
      "attributes": [
        {
          "id": "attributes.default.quality",
          "name": "Quality",
          "type": "range_1to5",
          "source": "Trustpilot",
          "options": [
            null
          ],
          "totalOccurrences": 1234,
          "occurrences": {
            "one": 2,
            "two": 0,
            "three": 0,
            "four": 10,
            "five": 60
          },
          "average": 4.23
        }
      ]
    }
  ]
}

Get batch product reviews summaries

Get summaries of product reviews for multiple SKUs. The summaries contain information about stars average, distribution and count.

HTTP method: POST

Authentication: API Key

URL: https://api.trustpilot.com/v1/product-reviews/business-units/{businessUnitId}/batch-summaries

Parameters

businessUnitId, Required string

The id of the business unit.

Example: .../v1/product-reviews/business-units/507f191e810c19729de860ea/batch-summaries

CURL

curl -X POST "https://api.trustpilot.com/v1/product-reviews/business-units/{businessUnitId}/batch-summaries" \
  -H "Content-Type: application/json" \
  -d '{
    "skus": [
      "ABCD-1234",
      "ACDC-4321"
    ]
  }' \
  -H "apikey: YOUR-API-KEY-HERE"

Request Body

{
  "skus": [
    "ABCD-1234",
    "ACDC-4321"
  ]
}

Response

{
  "summaries": [
    {
      "sku": "ABCD-1234",
      "numberOfReviews": {
        "total": 14,
        "oneStar": 2,
        "twoStars": 3,
        "threeStars": 2,
        "fourStars": 5,
        "fiveStars": 2
      },
      "starsAverage": 3.1
    }
  ]
}

Get product reviews summary

Get a summary of product reviews for a single or multiple SKU(s). The summary contains information about stars average, distribution and count.

HTTP method: GET

Authentication: API Key

URL: https://api.trustpilot.com/v1/product-reviews/business-units/{businessUnitId}

Parameters

businessUnitId, Required string

The id of the business unit.

Example: .../v1/product-reviews/business-units/507f191e810c19729de860ea

sku, Required array

A single or multiple comma-separated SKUs of the product(s).

Example: ?sku=ABCD-1234,ACDC-4321

locale, Optional string

The language in which the attributes, if any, are returned

Example: ?locale=da-DK

CURL

curl -X GET "https://api.trustpilot.com/v1/product-reviews/business-units/{businessUnitId}" \
  -G \
  --data-urlencode "sku=[
    "ABCD-1234",
    "ACDC-4321"
  ]" \
  -H "apikey: YOUR-API-KEY-HERE"

Response

{
  "links": [
    {
      "href": "<Url for the resource>",
      "method": "<Http method for the resource>",
      "rel": "<Description of the relation>"
    }
  ],
  "numberOfReviews": {
    "total": 14,
    "oneStar": 2,
    "twoStars": 3,
    "threeStars": 2,
    "fourStars": 5,
    "fiveStars": 2
  },
  "starsAverage": 3.1,
  "attributes": [
    {
      "id": "attributes.default.quality",
      "name": "Quality",
      "type": "range_1to5",
      "source": "Trustpilot",
      "options": [
        null
      ],
      "totalOccurrences": 1234,
      "occurrences": {
        "one": 2,
        "two": 0,
        "three": 0,
        "four": 10,
        "five": 60
      },
      "average": 4.23
    }
  ]
}

Get product reviews

This method allows you to get business unit product reviews for SKUs and / or productUrls. Note: Even though productUrl and sku are listed as optional parameters at least one of them must be specified. It includes review content, date of creation of review, individual star rating, id and display name of the consumer who wrote the review. Pagination and filtering reviews by language is also possible.

HTTP method: GET

Authentication: API Key

URL: https://api.trustpilot.com/v1/product-reviews/business-units/{businessUnitId}/reviews

Parameters
- businessUnitId, Required string
  
  Example: .../v1/product-reviews/business-units/5408d4b9065464000578ca81/reviews
- page, Optional integer
  
  The page to retrieve. If the page number requested is higher than the available number of pages an empty array will be returned.
  
  Example: ?page=1
- perPage, Optional integer
  
  The number of reviews to retrieve per page.
  
  Example: ?perPage=3
- productUrl, Optional array
  
  The url of the product. Optional only if sku is provided.
  
  Example: ?productUrl=http%3A%2F%2Fwww.mycompanystore.com%2Fproducts%2Fimages%2F12345.jpg
- sku, Optional array
  
  The sku of the product. Optional only if productUrl is provided.
  
  Example: ?sku=ABCD-1234,ACDC-4321
- language, Optional string
  
  Filter reviews by language.
  
  Example: ?language=en
- stars, Optional array
  
  Filter reviews with a specific number of stars.
  
  Example: ?stars=5
- locale, Optional string
  
  The language in which the attributes, if any, are returned
  
  Example: ?locale=da-DK
- attributeIds, Optional array
  
  A comma-separated list of attribute ids
  
  Example: ?attributeIds=attributes.default.quality,attributes.default.value-for-money
- hasAttachments, Optional boolean
  
  A boolean flag to filter reviews that have or not published attachments.
  
  Example: ?hasAttachments={hasAttachments}
- CURL
curl -X GET "https://api.trustpilot.com/v1/product-reviews/business-units/{businessUnitId}/reviews" \ -H "apikey: YOUR-API-KEY-HERE"
Response
```
{
  "productReviews": [
    {
      "id": "507f191e810c19729de860ea",
      "createdAt": "2013-09-07T13:37:00",
      "stars": 4,
      "content": "This product was nice, but slightly too soft.",
      "consumer": {
        "id": "507f191e810c19729de860ea",
        "displayName": "John Doe"
      },
      "language": "en",
      "attributeRatings": [
        {
          "attributeId": "attributes.default.quality",
          "attributeName": "Quality",
          "attributeType": "range_1to5",
          "attributeOptions": [
            null
          ],
          "rating": 4
        }
      ],
      "attachments": [
        {
          "id": "507f191e810c19729de860ea",
          "state": "Published",
          "processedFiles": [
            {
              "dimension": "1024pxWide",
              "mimeType": "image/png",
              "url": "https://productreviews-attachments.trustpilot.com/507f191e810c19729de860ea_1024pxWide.png"
            }
          ]
        }
      ],
      "firstCompanyComment": {
        "comment": "Thank you for your review",
        "createdAt": "2013-09-07T13:37:00"
      }
    }
  ],
  "links": [
    {
      "href": "<Url for the resource>",
      "method": "<Http method for the resource>",
      "rel": "<Description of the relation>"
    }
  ]
}
```

Get private product reviews

Given a list of SKUs or product urls return a list of product reviews. This method includes private information such as consumer e-mail and reference id. By default only published reviews are returned. To get reviews with other states, provide a list in the state field. Pagination is used to retrieve all results.

HTTP method: GET

Authentication: Business user OAuth Token

URL: https://api.trustpilot.com/v1/private/product-reviews/business-units/{businessUnitId}/reviews

Parameters

businessUnitId, Required string

Example: .../v1/private/product-reviews/business-units/5408d4b9065464000578ca81/reviews

page, Optional integer

The page to retrieve. If the page number requested is higher than the available number of pages an empty array will be returned.

Example: ?page=1

perPage, Optional integer

The number of reviews to retrieve per page.

Example: ?perPage=3

sku, Optional array

Filter reviews by product Stock-Keeping Unit (SKU) identifier

Example: ?sku=ABCD-1234,ACDC-4321

language, Optional string

Filter reviews by language.

Example: ?language=en

state, Optional array

Which reviews to retrieve according to their review state. Default is Published.

Example: ?state=published,unpublished

locale, Optional string

The language in which the attributes, if any, are returned

Example: ?locale=da-DK

CURL

curl -X GET "https://api.trustpilot.com/v1/private/product-reviews/business-units/{businessUnitId}/reviews" \
  -H "Authorization: Bearer YOUR-ACCESS-TOKEN"

Response

{
  "links": [
    {
      "href": "<Url for the resource>",
      "method": "<Http method for the resource>",
      "rel": "<Description of the relation>"
    }
  ],
  "productReviews": [
    {
      "id": "507f191e810c19729de860ea",
      "createdAt": "2013-09-07T13:37:00",
      "updatedAt": "2013-09-07T13:37:00",
      "businessUnitId": "507f191e810c19729de860ea",
      "stars": 4,
      "content": "This product was nice, but slightly too soft.",
      "product": {
        "id": "507f191e810c19729de860ea",
        "productUrl": "http://www.mycompanystore.com/products/12345.htm",
        "productImages": [
          {
            "type": "100pxWide",
            "url": "http://www.mycompanystore.com/products/images/12345.jpg"
          }
        ],
        "name": "Metal Toy Car",
        "sku": "ABC-1234",
        "gtin": "01234567890",
        "mpn": "7TX1641",
        "brand": "Acme"
      },
      "consumer": {
        "id": "507f191e810c19729de860ea",
        "email": "johndoe@somewhere.com",
        "name": "John Doe"
      },
      "referenceId": "123ABC",
      "locale": "en-US",
      "language": "en",
      "redirectUri": "https://www.example.com",
      "state": "published",
      "hasModerationHistory": true,
      "conversationId": "507f191e810c19729de860ea",
      "attributeRatings": [
        {
          "attributeId": "attributes.default.quality",
          "attributeName": "Quality",
          "attributeType": "range_1to5",
          "attributeOptions": [
            null
          ],
          "rating": 4
        }
      ],
      "attachments": [
        {
          "id": "507f191e810c19729de860ea",
          "state": "Published",
          "processedFiles": [
            {
              "dimension": "1024pxWide",
              "mimeType": "image/png",
              "url": "https://productreviews-attachments.trustpilot.com/507f191e810c19729de860ea_1024pxWide.png"
            }
          ]
        }
      ]
    }
  ],
  "total": 0
}

Get private product review

Gets a single private product review. This method includes private information such as consumer e-mail and reference id.

HTTP method: GET

Authentication: Business user OAuth Token

URL: https://api.trustpilot.com/v1/private/product-reviews/{reviewId}

Parameters

reviewId, Required string

The id of the product review

Example: .../v1/private/product-reviews/507f191e810c19729de860ea

locale, Optional string

The language in which the attributes, if any, are returned

Example: ?locale=da-DK

CURL

curl -X GET "https://api.trustpilot.com/v1/private/product-reviews/{reviewId}" \
  -H "Authorization: Bearer YOUR-ACCESS-TOKEN"

Response

{
  "id": "507f191e810c19729de860ea",
  "createdAt": "2013-09-07T13:37:00",
  "updatedAt": "2013-09-07T13:37:00",
  "businessUnitId": "507f191e810c19729de860ea",
  "stars": 4,
  "content": "This product was nice, but slightly too soft.",
  "product": {
    "id": "507f191e810c19729de860ea",
    "productUrl": "http://www.mycompanystore.com/products/12345.htm",
    "productImages": [
      {
        "type": "100pxWide",
        "url": "http://www.mycompanystore.com/products/images/12345.jpg"
      }
    ],
    "name": "Metal Toy Car",
    "sku": "ABC-1234",
    "gtin": "01234567890",
    "mpn": "7TX1641",
    "brand": "Acme"
  },
  "consumer": {
    "id": "507f191e810c19729de860ea",
    "email": "johndoe@somewhere.com",
    "name": "John Doe"
  },
  "referenceId": "123ABC",
  "locale": "en-US",
  "language": "en",
  "redirectUri": "https://www.example.com",
  "state": "published",
  "hasModerationHistory": true,
  "conversationId": "507f191e810c19729de860ea",
  "attributeRatings": [
    {
      "attributeId": "attributes.default.quality",
      "attributeName": "Quality",
      "attributeType": "range_1to5",
      "attributeOptions": [
        null
      ],
      "rating": 4
    }
  ],
  "attachments": [
    {
      "id": "507f191e810c19729de860ea",
      "state": "Published",
      "processedFiles": [
        {
          "dimension": "1024pxWide",
          "mimeType": "image/png",
          "url": "https://productreviews-attachments.trustpilot.com/507f191e810c19729de860ea_1024pxWide.png"
        }
      ]
    }
  ]
}

Create product review conversation

Prepares the review for participating in a conversation by issuing a conversation ID.

HTTP method: POST

Authentication: Business user OAuth Token

URL: https://api.trustpilot.com/v1/private/product-reviews/{reviewId}/create-conversation

Parameters
- reviewId, Required string
  
  The id of the product review
  
  Example: .../v1/private/product-reviews/507f191e810c19729de860ea/create-conversation
- CURL
curl -X POST "https://api.trustpilot.com/v1/private/product-reviews/{reviewId}/create-conversation" \ -H "Authorization: Bearer YOUR-ACCESS-TOKEN"
Response
```
{
  "conversationId": "507f191e810c19729de860ea"
}
```
Get imported product reviews summary

Get a summary of imported product reviews for a single or multiple SKUs. The summary contains information about stars average, distribution and count.

HTTP method: GET

Authentication: API Key

URL: https://api.trustpilot.com/v1/product-reviews/business-units/{businessUnitId}/imported-reviews-summaries

Parameters
- businessUnitId, Required string
  
  The id of the business unit.
  
  Example: .../v1/product-reviews/business-units/507f191e810c19729de860ea/imported-reviews-summaries
- sku, Required array
  
  The SKU of the product, or multiple comma-separated SKUs (which will be summarized together).
  
  Example: ?sku=ABCD-1234,ACDC-4321
- CURL
curl -X GET "https://api.trustpilot.com/v1/product-reviews/business-units/{businessUnitId}/imported-reviews-summaries" \ -G \ --data-urlencode "sku=[ "ABCD-1234", "ACDC-4321" ]" \ -H "apikey: YOUR-API-KEY-HERE"
Response
```
{
  "links": [
    {
      "href": "<Url for the resource>",
      "method": "<Http method for the resource>",
      "rel": "<Description of the relation>"
    }
  ],
  "numberOfReviews": {
    "total": 14,
    "oneStar": 2,
    "twoStars": 3,
    "threeStars": 2,
    "fourStars": 5,
    "fiveStars": 2
  },
  "starsAverage": 3.1
}
```
Get imported product reviews

This method allows you to get imported product reviews by business unit id, SKUs and language. It includes review content, date of creation of review, individual star rating and display name of the consumer who wrote the review. It is possible to paginate the results.

HTTP method: GET

Authentication: API Key

URL: https://api.trustpilot.com/v1/product-reviews/business-units/{businessUnitId}/imported-reviews

Parameters
- businessUnitId, Required string
  
  Example: .../v1/product-reviews/business-units/507f191e810c19729de860ea/imported-reviews
- page, Optional integer
  
  The page to retrieve. If the page number requested is higher than the available number of pages an empty array will be returned.
  
  Example: ?page=1
- perPage, Optional integer
  
  The number of reviews to retrieve per page.
  
  Example: ?perPage=3
- sku, Required array
  
  The sku of the product.
  
  Example: ?sku=ABCD-1234,ACDC-4321
- stars, Optional array
  
  Star ratings to search for
  
  Example: ?stars=4,5
- language, Optional string
  
  Filter reviews by language.
  
  Example: ?language=en
- CURL
curl -X GET "https://api.trustpilot.com/v1/product-reviews/business-units/{businessUnitId}/imported-reviews" \ -G \ --data-urlencode "sku=[ "ABCD-1234", "ACDC-4321" ]" \ -H "apikey: YOUR-API-KEY-HERE"
Response
```
{
  "productReviews": [
    {
      "createdAt": "2013-09-07T13:37:00",
      "stars": 4,
      "content": "This product was nice, but slightly too soft.",
      "consumer": {
        "name": "John Doe"
      },
      "source": {
        "name": "External Partner"
      },
      "type": "Business",
      "language": "en"
    }
  ],
  "links": [
    {
      "href": "<Url for the resource>",
      "method": "<Http method for the resource>",
      "rel": "<Description of the relation>"
    }
  ]
}
```

Create product review invitation link

Given information about the consumer and the product(s) purchased, get a link that can be sent to the consumer to request reviews. Note that the products should either be specified as product ids (see the Product API) or as a product with product details. It is only possible to use one of these methods for specifying product information.

HTTP method: POST

Authentication: Business user OAuth Token

URL: https://api.trustpilot.com/v1/private/product-reviews/business-units/{businessUnitId}/invitation-links

Parameters

businessUnitId, Required string

Example: .../v1/private/product-reviews/business-units/{businessUnitId}/invitation-links

CURL

curl -X POST "https://api.trustpilot.com/v1/private/product-reviews/business-units/{businessUnitId}/invitation-links" \
  -H "Content-Type: application/json" \
  -d '{
    "consumer": {
      "email": "johndoe@somewhere.com",
      "name": "John Doe"
    },
    "referenceId": "123ABC",
    "locale": "en-US",
    "redirectUri": "https://www.example.com",
    "products": [
      {
        "productUrl": "http://www.mycompanystore.com/products/12345.htm",
        "imageUrl": "http://www.mycompanystore.com/products/images/12345.jpg",
        "name": "Metal Toy Car",
        "sku": "ABC-1234",
        "gtin": "01234567890",
        "mpn": "7TX1641",
        "brand": "Acme"
      }
    ],
    "productIds": [
      "507f191e810c19729de860ea",
      "507f191e810c19729de860eb",
      "507f191e810c19729de860ec"
    ],
    "source": "Kickstart",
    "orderId": "507f191e810c19729de860ea",
    "serviceReviewInvitationId": "507f191e810c19729de860ea",
    "productReviewInvitationId": "507f191e810c19729de860ea"
  }' \
  -H "Authorization: Bearer YOUR-ACCESS-TOKEN"

Request Body

{
  "consumer": {
    "email": "johndoe@somewhere.com",
    "name": "John Doe"
  },
  "referenceId": "123ABC",
  "locale": "en-US",
  "redirectUri": "https://www.example.com",
  "products": [
    {
      "productUrl": "http://www.mycompanystore.com/products/12345.htm",
      "imageUrl": "http://www.mycompanystore.com/products/images/12345.jpg",
      "name": "Metal Toy Car",
      "sku": "ABC-1234",
      "gtin": "01234567890",
      "mpn": "7TX1641",
      "brand": "Acme"
    }
  ],
  "productIds": [
    "507f191e810c19729de860ea",
    "507f191e810c19729de860eb",
    "507f191e810c19729de860ec"
  ],
  "source": "Kickstart",
  "orderId": "507f191e810c19729de860ea",
  "serviceReviewInvitationId": "507f191e810c19729de860ea",
  "productReviewInvitationId": "507f191e810c19729de860ea"
}

Response

{
  "reviewLinkId": "d9339202586bf5f39200f605f09ccd90",
  "reviewUrl": "https://products.trustpilot.com/evaluate/d9339202586bf5f39200f605f09ccd90"
}

Product Reviews API

Create comment

Parameters

Request Body

Response

Get conversation

Parameters

Response

Set conversation state

Parameters

Request Body

Get comment

Parameters

Response

Update comment

Parameters

Request Body

Response

Get public conversation

Parameters

Response

Get product reviews summaries list

Parameters

Response

Get public batch aggregated attribute rating summaries

Parameters

Request Body

Response

Get batch product reviews summaries

Parameters

Request Body

Response

Get product reviews summary

Parameters

Response

Get product reviews

Parameters

Response

Get private product reviews

Parameters

Response

Get private product review

Parameters

Response

Create product review conversation

Parameters

Response

Get imported product reviews summary

Parameters

Response

Get imported product reviews

Parameters

Response

Create product review invitation link

Parameters

Request Body

Response