catalog

Embed
Preview of the card
<a href="https://hermeticor.com/docs/ref-catalog"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/9fc720ba-4c3d-4e83-bd29-1f3b952f36da/social-card.svg?v=3e7ae33eec8b" alt="catalog" width="600" height="315"></a>
PATCHhttps://hermeticor.com/v1/reviews/{id}

Moderate (pending | published | featured | unpublished | rejected), reply publicly, or edit rating, text, images and type

Parameters

idstringpathrequired

Request body

application/json
statusstring
pending | published | featured | unpublished | rejected
ratinginteger
titlestring
bodystring
authorNamestring
verifiedboolean
imagesstring[]
reviewTypestring
review | question | rating | store
productIdstring
publicReplystring
rejectionReasonstring
{
  "status": "pending",
  "rating": 0,
  "title": "string",
  "body": "string",
  "authorName": "string",
  "verified": true,
  "images": [
    "string"
  ],
  "reviewType": "review",
  "productId": "string",
  "publicReply": "string",
  "rejectionReason": "string"
}

Code samples

cURL
curl -X PATCH "https://hermeticor.com/v1/reviews/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"status":"pending","rating":0,"title":"string","body":"string","authorName":"string","verified":true,"images":["string"],"reviewType":"review","productId":"string","publicReply":"string","rejectionReason":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "id": "string",
  "productId": "string",
  "profileId": "string",
  "authorName": "string",
  "rating": 0,
  "title": "string",
  "body": "string",
  "status": "pending",
  "verified": true,
  "source": "string",
  "reviewType": "review",
  "images": [
    "string"
  ],
  "publicReply": "string",
  "publicReplyAt": "2024-01-01T00:00:00Z",
  "rejectionReason": "string",
  "reviewerEmail": "string",
  "orderId": "string",
  "rewardCode": "string",
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z"
}
Schema
idstringrequired
productIdstringrequired
profileIdstringrequired
authorNamestringrequired
ratingintegerrequired
titlestringrequired
bodystringrequired
statusstringrequired
pending | published | featured | unpublished | rejected
verifiedbooleanrequired
sourcestringrequired
reviewTypestringrequired
review | question | rating | store
imagesstring[]required
publicReplystringrequired
publicReplyAtstringrequired
rejectionReasonstringrequired
reviewerEmailstringrequired
orderIdstringrequired
rewardCodestringrequired
createdAtstringrequired
updatedAtstringrequired
4XX Default Response
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
detailsobject
5XX Default Response

Same as 4XX · PATCH /v1/reviews/{id}

GEThttps://hermeticor.com/v1/review-settings

Review-for-coupon incentive

Code samples

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

Responses

200 Default Response
Example
{
  "rewardPoolId": "string",
  "rewardMinRating": 0,
  "rewardRequiresMedia": true
}
Schema
rewardPoolIdstringrequired
rewardMinRatingintegerrequired
rewardRequiresMediabooleanrequired
4XX Default Response

Same as 4XX · PATCH /v1/reviews/{id}

5XX Default Response

Same as 4XX · PATCH /v1/reviews/{id}

PUThttps://hermeticor.com/v1/review-settings

Request body

application/json
rewardPoolIdstringrequired
rewardMinRatinginteger
= 4
rewardRequiresMediaboolean
= false
{
  "rewardPoolId": "string",
  "rewardMinRating": 4,
  "rewardRequiresMedia": false
}

Code samples

cURL
curl -X PUT "https://hermeticor.com/v1/review-settings" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"rewardPoolId":"string","rewardMinRating":4,"rewardRequiresMedia":false}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · GET /v1/review-settings

4XX Default Response

Same as 4XX · PATCH /v1/reviews/{id}

5XX Default Response

Same as 4XX · PATCH /v1/reviews/{id}

GEThttps://hermeticor.com/v1/review-feeds/google

URLs of the Google Shopping product reviews feed (XML, schema 2.3, 5,000 reviews per file) to give Merchant Center

Parameters

publisherstringquery
= Store

Code samples

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

Responses

200 Default Response
Example
{
  "url": "string",
  "pages": [
    "string"
  ]
}
Schema
urlstringrequired
pagesstring[]required
4XX Default Response

Same as 4XX · PATCH /v1/reviews/{id}

5XX Default Response

Same as 4XX · PATCH /v1/reviews/{id}

POSThttps://hermeticor.com/v1/review-feeds/google/replace

Revoke every review feed link made so far and return new ones

Parameters

publisherstringquery
= Store

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/review-feeds/google/replace" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · GET /v1/review-feeds/google

4XX Default Response

Same as 4XX · PATCH /v1/reviews/{id}

5XX Default Response

Same as 4XX · PATCH /v1/reviews/{id}

GEThttps://hermeticor.com/feeds/reviews/{token}

Google Shopping product reviews feed (the signed link from /v1/review-feeds/google)

Parameters

pageintegerquery
= 1
tokenstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/feeds/reviews/{token}"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
{}
4XX Default Response

Same as 4XX · PATCH /v1/reviews/{id}

5XX Default Response

Same as 4XX · PATCH /v1/reviews/{id}

Updated