catalog

Embed

<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/web-feeds/{id}

Parameters

idstringpathrequired

Request body

application/json

namestring

urlstring

formatstring

json | rss | xml

refreshHoursinteger

methodstring

GET | POST

requestBodystring

{
  "name": "string",
  "url": "string",
  "format": "json",
  "refreshHours": 0,
  "method": "GET",
  "requestBody": "string"
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/web-feeds/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","url":"string","format":"json","refreshHours":0,"method":"GET","requestBody":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "name": "string",
  "url": "string",
  "format": "json",
  "refreshHours": 0,
  "method": "GET",
  "requestBody": "string",
  "lastFetchedAt": "2024-01-01T00:00:00Z",
  "lastError": "string",
  "cached": true
}

Schema

idstringrequired

namestringrequired

urlstringrequired

formatstringrequired

json | rss | xml

refreshHoursintegerrequired

methodstringrequired

GET | POST

requestBodystringrequired

lastFetchedAtstringrequired

lastErrorstringrequired

cachedbooleanrequired

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/web-feeds/{id}

POSThttps://hermeticor.com/v1/web-feeds/{id}/refresh

Parameters

idstringpathrequired

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/web-feeds/{id}/refresh" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ok": true
}

Schema

okbooleanrequired

true

4XX Default Response

Same as 4XX · PATCH /v1/web-feeds/{id}

5XX Default Response

Same as 4XX · PATCH /v1/web-feeds/{id}

GEThttps://hermeticor.com/v1/reviews

Parameters

limitintegerquery

= 50

cursorstringquery

statusstringquery

pending | published | featured | unpublished | rejected

productIdstringquery

profileIdstringquery

reviewTypestringquery

review | question | rating | store

ratingintegerquery

minRatingintegerquery

verifiedstringquery

true | false

hasMediastringquery

true | false

hasReplystringquery

true | false

qstringquery

createdFromstringquery

createdTostringquery

updatedFromstringquery

updatedTostringquery

sortstringquery

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/reviews" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "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"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem96[]required

Show child parameters

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

nextCursorstringrequired

4XX Default Response

Same as 4XX · PATCH /v1/web-feeds/{id}

5XX Default Response

Same as 4XX · PATCH /v1/web-feeds/{id}

POSThttps://hermeticor.com/v1/reviews

Ingest a review (pending unless status is set); emits review_created for the profile

Request body

application/json

productIdstringrequired

reviewTypestring

review | question | rating | store = review

ratinginteger

titlestring

bodystring

authorNamestring

profileIdstring

verifiedboolean

statusstring

pending | published | featured | unpublished | rejected

imagesstring[]

= []

reviewerEmailstring

orderIdstring

publicReplystring

{
  "productId": "string",
  "reviewType": "review",
  "rating": 0,
  "title": "string",
  "body": "string",
  "authorName": "string",
  "profileId": "string",
  "verified": true,
  "status": "pending",
  "images": [],
  "reviewerEmail": "string",
  "orderId": "string",
  "publicReply": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/reviews" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"productId":"string","reviewType":"review","rating":0,"title":"string","body":"string","authorName":"string","profileId":"string","verified":true,"status":"pending","images":[],"reviewerEmail":"string","orderId":"string","publicReply":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 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

Same as 4XX · PATCH /v1/web-feeds/{id}

5XX Default Response

Same as 4XX · PATCH /v1/web-feeds/{id}

GEThttps://hermeticor.com/v1/reviews/aggregates

Published-review count, average and histogram per product

Parameters

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/v1/reviews/aggregates" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

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 · PATCH /v1/web-feeds/{id}

5XX Default Response

Same as 4XX · PATCH /v1/web-feeds/{id}

GEThttps://hermeticor.com/v1/reviews/aggregates/{productId}

Parameters

productIdstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/reviews/aggregates/{productId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "productId": "string",
  "count": 0,
  "average": 0,
  "histogram": {}
}

Schema

productIdstringrequired

countintegerrequired

averagenumberrequired

histogramobjectrequired

4XX Default Response

Same as 4XX · PATCH /v1/web-feeds/{id}

5XX Default Response

Same as 4XX · PATCH /v1/web-feeds/{id}

GEThttps://hermeticor.com/v1/reviews/{id}

Parameters

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/reviews/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/reviews

4XX Default Response

Same as 4XX · PATCH /v1/web-feeds/{id}

5XX Default Response

Same as 4XX · PATCH /v1/web-feeds/{id}

DELETEhttps://hermeticor.com/v1/reviews/{id}

Parameters

idstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/reviews/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · POST /v1/web-feeds/{id}/refresh

4XX Default Response

Same as 4XX · PATCH /v1/web-feeds/{id}

5XX Default Response

Same as 4XX · PATCH /v1/web-feeds/{id}

Next part

Updated Nov 8, 2026

Was this page helpful?