reviews

Embed
Preview of the card
<a href="https://hermeticor.com/docs/ref-reviews"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/d9f3b7c3-90b9-42b2-b728-ba8f84b3ac6c/social-card.svg?v=3e7ae33eec8b" alt="reviews" width="600" height="315"></a>
GEThttps://hermeticor.com/ingest/v1/reviews

Published reviews of one product, newest first

Parameters

productIdstringqueryrequired
limitintegerquery
= 20
cursorstringquery
reviewTypestringquery
review | question | store
ratingintegerquery
minRatingintegerquery
verifiedstringquery
true | false
hasMediastringquery
true | false
sortstringquery
-created | created | -rating | rating | featured = -created

Code samples

cURL
curl -X GET "https://hermeticor.com/ingest/v1/reviews?productId=<productId>" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "productId": "string",
      "reviewType": "string",
      "rating": 0,
      "title": "string",
      "body": "string",
      "authorName": "string",
      "verified": true,
      "featured": true,
      "images": [
        "string"
      ],
      "publicReply": "string",
      "publicReplyAt": "2024-01-01T00:00:00Z",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsobject[]required
Show child parameters
idstringrequired
productIdstringrequired
reviewTypestringrequired
ratingintegerrequired
titlestringrequired
bodystringrequired
authorNamestringrequired
verifiedbooleanrequired
featuredbooleanrequired
imagesstring[]required
publicReplystringrequired
publicReplyAtstringrequired
createdAtstringrequired
nextCursorstringrequired
4XX Default Response
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
detailsobject
5XX Default Response

Same as 4XX · GET /ingest/v1/reviews

POSThttps://hermeticor.com/ingest/v1/reviews

Submit a product review; it stays pending until a moderator publishes it

Request body

application/json
productIdstringrequired
reviewTypestring
review | question | store = review
ratinginteger
authorNamestring
titlestring
bodystring
emailstring
orderIdstring
imagesstring[]
= []
{
  "productId": "string",
  "reviewType": "review",
  "rating": 0,
  "authorName": "string",
  "title": "string",
  "body": "string",
  "email": "string",
  "orderId": "string",
  "images": []
}

Code samples

cURL
curl -X POST "https://hermeticor.com/ingest/v1/reviews" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"productId":"string","reviewType":"review","rating":0,"authorName":"string","title":"string","body":"string","email":"string","orderId":"string","images":[]}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

202 Default Response
Example
{
  "ok": true
}
Schema
okbooleanrequired
true
4XX Default Response

Same as 4XX · GET /ingest/v1/reviews

5XX Default Response

Same as 4XX · GET /ingest/v1/reviews

POSThttps://hermeticor.com/ingest/v1/reviews/media

Upload one review photo (multipart field "file"; JPEG, PNG, WebP or GIF); send the returned URL in the review's images

Code samples

cURL
curl -X POST "https://hermeticor.com/ingest/v1/reviews/media" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

201 Default Response
Example
{
  "url": "string"
}
Schema
urlstringrequired
4XX Default Response

Same as 4XX · GET /ingest/v1/reviews

5XX Default Response

Same as 4XX · GET /ingest/v1/reviews

GEThttps://hermeticor.com/ingest/v1/review-values-reports

Count, average and 1-5 histogram of published reviews, per product

Parameters

productIdstringquery
limitintegerquery
Page size; omitted returns the whole list
cursorstringquery
Opaque: the nextCursor of the previous page

Code samples

cURL
curl -X GET "https://hermeticor.com/ingest/v1/review-values-reports" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "productId": "string",
      "count": 0,
      "average": 0,
      "histogram": {}
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem80[]required
Show child parameters
productIdstringrequired
countintegerrequired
averagenumberrequired
histogramobjectrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · GET /ingest/v1/reviews

5XX Default Response

Same as 4XX · GET /ingest/v1/reviews

Updated