Reviews

Review limits

GET read_reviews

Fetch review moderation limits and enums.

Returns the current limits and supported values for review lists, content, photos, moderation, and display. Use these values to configure your app.

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Errors

401 UNAUTHORIZED
Authorization header missing, malformed, or token invalid/expired.
402 SUBSCRIPTION_REQUIRED
The store does not have an active or trialing subscription.
403 STORE_API_SCOPE_REQUIRED
Token is valid but lacks the required scope for this call.
429 RATE_LIMITED
The token's request allowance is exhausted. Retry after the Retry-After header.

curl 'https://api-store.tringify.com/api/2025-01/reviews/limits' \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/reviews/limits", {
  method: "GET",
  headers: {"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
});
const data = await res.json();

import requests

res = requests.get(
    "https://api-store.tringify.com/api/2025-01/reviews/limits",
    headers={"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{"data":{"blocked_word_max_length":50,"blocked_words_max":200,"bulk_max":500,"list_max_limit":500,"list_page_size":20,"max_content_length_max":5000,"max_content_length_min":500,"max_images_max":5,"min_content_length_max":100,"min_content_length_min":10,"moderation_modes":["auto_approve","manual","disabled"],"moderation_reason_max_length":1000,"page_size_options":[20,50,100,200,500],"response_max_length":2000,"reviewer_displays":["anonymous","first_name","full_name","initials"],"reviewer_email_max_length":255,"reviewer_name_max_length":100,"search_max_length":200,"sort_options":["newest","oldest","highest_rated","lowest_rated","most_helpful"],"statuses":["pending","approved","rejected","hidden"],"title_max_length":200},"success":true}

List reviews

GET read_reviews

List the store-wide product review moderation queue.

Search and filters run before pagination. The default sort is newest first. Pages follow next_cursor; has_more is false on the last page. total is exact, except that a search or response filter counts at most the first 10,000 matches and then sets total_capped. An invalid or oversized limit is rejected. Fields you have no scope for are left out: reviewer_email and customer_id need read_customers, product_title needs read_products, and order_id needs read_orders.

Query parameters

Name	Type	Description
`status`	`string`	pending, approved, rejected, or hidden. Example: `pending`
`rating`	`integer`	One rating from 1 through 5. Use ratings to match several. Example: `5`
`ratings`	`string`	Comma-separated ratings from 1 through 5, at most five values, for example 1,2. Cannot be combined with rating. Example: `1,2`
`product_id`	`integer`	Only reviews for this product. Example: `42`
`has_store_response`	`boolean`	Only reviews with or without a merchant response. Example: `true`
`search`	`string`	Search title and content. Example: `quality`
`sort_by`	`string`	newest, oldest, highest_rated, lowest_rated, or most_helpful. Allowed values `newestoldesthighest_ratedlowest_ratedmost_helpful` Example: `newest`
`limit`	`integer`	Rows to return, from 1 through list_max_limit. Larger values are rejected. Example: `20`
`cursor`	`string`	next_cursor from the previous page, sent with the same filters and sort_by. Omit it for the first page.

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Errors

401 UNAUTHORIZED
Authorization header missing, malformed, or token invalid/expired.
402 SUBSCRIPTION_REQUIRED
The store does not have an active or trialing subscription.
403 STORE_API_SCOPE_REQUIRED
Token is valid but lacks the required scope for this call.
429 RATE_LIMITED
The token's request allowance is exhausted. Retry after the Retry-After header.
400 STORE_API_INVALID_REQUEST_BODY
The query or body is malformed or contains an unknown field.
400 VALIDATION_LIST_INVALID_LIMIT
limit is outside the supported range.
400 VALIDATION_SEARCH_TOO_LONG
search exceeds search_max_length.
400 ADMIN_REVIEW_STATUS_FILTER_INVALID
status is not supported.
400 ADMIN_REVIEW_RATING_FILTER_RANGE
rating is outside 1 through 5.
400 ADMIN_REVIEW_LIST_INVALID_SORT_BY
sort_by is not supported.
400 ADMIN_REVIEW_LIST_CURSOR_INVALID
cursor is malformed, or was issued for other filters or another sort.

curl 'https://api-store.tringify.com/api/2025-01/reviews?has_store_response=true&limit=20&product_id=42&rating=5&ratings=1,2&search=quality&sort_by=newest&status=pending' \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/reviews?has_store_response=true&limit=20&product_id=42&rating=5&ratings=1,2&search=quality&sort_by=newest&status=pending", {
  method: "GET",
  headers: {"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
});
const data = await res.json();

import requests

res = requests.get(
    "https://api-store.tringify.com/api/2025-01/reviews?has_store_response=true&limit=20&product_id=42&rating=5&ratings=1,2&search=quality&sort_by=newest&status=pending",
    headers={"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{"success":true,"data":{"reviews":[],"stats":{"total_count":0,"average_rating":0,"rating_breakdown":{"one":0,"two":0,"three":0,"four":0,"five":0},"reviews_with_images":0,"verified_purchases":0},"total":0,"total_capped":false,"limit":20,"has_more":false,"next_cursor":"","status_counts":{"pending":0,"approved":0,"rejected":0,"hidden":0},"enable_responses":true}}

Get review

GET read_reviews

Fetch one review in this store.

Returns the moderation record, photos, helpful and unhelpful vote counts, and store response. It does not list individual voters. Fields you have no scope for are left out: reviewer_email and customer_id need read_customers, product_title needs read_products, and order_id needs read_orders.

Path parameters

Name	Type	Description
`id` required	`uuid`	Review id. Example: `5ff7d4ea-3250-4a4d-9d26-07f64d917d31`

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Errors

401 UNAUTHORIZED
Authorization header missing, malformed, or token invalid/expired.
402 SUBSCRIPTION_REQUIRED
The store does not have an active or trialing subscription.
403 STORE_API_SCOPE_REQUIRED
Token is valid but lacks the required scope for this call.
429 RATE_LIMITED
The token's request allowance is exhausted. Retry after the Retry-After header.
400 STORE_API_INVALID_REQUEST_BODY
The query or body is malformed or contains an unknown field.
404 ADMIN_REVIEW_NOT_FOUND
The review does not exist in this store.

curl 'https://api-store.tringify.com/api/2025-01/reviews/5ff7d4ea-3250-4a4d-9d26-07f64d917d31' \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/reviews/5ff7d4ea-3250-4a4d-9d26-07f64d917d31", {
  method: "GET",
  headers: {"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
});
const data = await res.json();

import requests

res = requests.get(
    "https://api-store.tringify.com/api/2025-01/reviews/5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    headers={"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{"success":true,"data":{"review":{"id":"5ff7d4ea-3250-4a4d-9d26-07f64d917d31","product_id":42,"product_title":"Trailblazer Tee","rating":5,"content":"Great quality.","reviewer_name":"Avery","reviewer_email":"avery@example.com","status":"approved","verified_purchase":true,"helpful_count":2,"unhelpful_count":0,"images":[],"created_at":"2026-09-01T12:00:00Z","updated_at":"2026-09-01T12:00:00Z"}}}

Moderate review

PUT write_reviews

Approve, reject, or hide one review.

Updates the review status and sends a review update event.

Path parameters

Name	Type	Description
`id` required	`uuid`	Review id. Example: `5ff7d4ea-3250-4a4d-9d26-07f64d917d31`

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Body parameters

Name	Type	Description
`status` required	`string`	approved, rejected, or hidden. Example: `approved`
`reason`	`string`	Optional moderation reason. Example: `Duplicate submission`

Errors

401 UNAUTHORIZED
Authorization header missing, malformed, or token invalid/expired.
402 SUBSCRIPTION_REQUIRED
The store does not have an active or trialing subscription.
403 STORE_API_SCOPE_REQUIRED
Token is valid but lacks the required scope for this call.
429 RATE_LIMITED
The token's request allowance is exhausted. Retry after the Retry-After header.
400 STORE_API_INVALID_REQUEST_BODY
The query or body is malformed or contains an unknown field.
404 ADMIN_REVIEW_NOT_FOUND
The review does not exist in this store.
400 ADMIN_REVIEW_MODERATION_STATUS_INVALID
status is not approved, rejected, or hidden.
400 ADMIN_REVIEW_MODERATION_REASON_TOO_LONG
reason exceeds moderation_reason_max_length.

curl -X PUT 'https://api-store.tringify.com/api/2025-01/reviews/5ff7d4ea-3250-4a4d-9d26-07f64d917d31' \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "reason": "Duplicate submission",
  "status": "approved"
}'

const res = await fetch("https://api-store.tringify.com/api/2025-01/reviews/5ff7d4ea-3250-4a4d-9d26-07f64d917d31", {
  method: "PUT",
  headers: {"Authorization":"Bearer YOUR_STORE_API_TOKEN","Content-Type":"application/json"},
  body: JSON.stringify({
    "reason": "Duplicate submission",
    "status": "approved"
  }),
});
const data = await res.json();

import requests

res = requests.put(
    "https://api-store.tringify.com/api/2025-01/reviews/5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    headers={"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
    json={
        "reason": "Duplicate submission",
        "status": "approved",
    },
)
data = res.json()

Response

200

Sample response

{"success":true,"data":{"review":{"id":"5ff7d4ea-3250-4a4d-9d26-07f64d917d31","product_id":42,"product_title":"Trailblazer Tee","rating":5,"content":"Great quality.","reviewer_name":"Avery","reviewer_email":"avery@example.com","status":"approved","verified_purchase":true,"helpful_count":2,"unhelpful_count":0,"images":[],"created_at":"2026-09-01T12:00:00Z","updated_at":"2026-09-01T12:00:00Z"}}}

Respond to review

PUT write_reviews

Add or replace the merchant response.

Responses must be enabled and the review must be approved.

Path parameters

Name	Type	Description
`id` required	`uuid`	Review id. Example: `5ff7d4ea-3250-4a4d-9d26-07f64d917d31`

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Body parameters

Name	Type	Description
`response` required	`string`	Merchant response text. Example: `Thanks for your feedback.`

Errors

401 UNAUTHORIZED
Authorization header missing, malformed, or token invalid/expired.
402 SUBSCRIPTION_REQUIRED
The store does not have an active or trialing subscription.
403 STORE_API_SCOPE_REQUIRED
Token is valid but lacks the required scope for this call.
429 RATE_LIMITED
The token's request allowance is exhausted. Retry after the Retry-After header.
400 STORE_API_INVALID_REQUEST_BODY
The query or body is malformed or contains an unknown field.
404 ADMIN_REVIEW_NOT_FOUND
The review does not exist in this store.
400 ADMIN_REVIEW_RESPONSE_REQUIRED
response is empty.
400 ADMIN_REVIEW_RESPONSE_TOO_LONG
response exceeds response_max_length.
403 ADMIN_REVIEW_RESPONSES_DISABLED
Store responses are disabled.
403 ADMIN_REVIEW_RESPOND_APPROVED_ONLY
Only approved reviews can receive a response.

curl -X PUT 'https://api-store.tringify.com/api/2025-01/reviews/5ff7d4ea-3250-4a4d-9d26-07f64d917d31/response' \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "response": "Thanks for your feedback."
}'

const res = await fetch("https://api-store.tringify.com/api/2025-01/reviews/5ff7d4ea-3250-4a4d-9d26-07f64d917d31/response", {
  method: "PUT",
  headers: {"Authorization":"Bearer YOUR_STORE_API_TOKEN","Content-Type":"application/json"},
  body: JSON.stringify({
    "response": "Thanks for your feedback."
  }),
});
const data = await res.json();

import requests

res = requests.put(
    "https://api-store.tringify.com/api/2025-01/reviews/5ff7d4ea-3250-4a4d-9d26-07f64d917d31/response",
    headers={"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
    json={
        "response": "Thanks for your feedback.",
    },
)
data = res.json()

Response

200

Sample response

{"success":true,"data":{"review":{"id":"5ff7d4ea-3250-4a4d-9d26-07f64d917d31","product_id":42,"product_title":"Trailblazer Tee","rating":5,"content":"Great quality.","reviewer_name":"Avery","reviewer_email":"avery@example.com","status":"approved","verified_purchase":true,"helpful_count":2,"unhelpful_count":0,"images":[],"created_at":"2026-09-01T12:00:00Z","updated_at":"2026-09-01T12:00:00Z"}}}

Remove review response

DELETE write_reviews

Remove the store response from one review.

Only the store response is removed; the review keeps its status and content. Responds with ADMIN_REVIEW_RESPONSE_REMOVED and sends a review update event with store_response in changed_fields. Removing a response that is already gone succeeds without changes.

Path parameters

Name	Type	Description
`id` required	`uuid`	Review id. Example: `5ff7d4ea-3250-4a4d-9d26-07f64d917d31`

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Errors

401 UNAUTHORIZED
Authorization header missing, malformed, or token invalid/expired.
402 SUBSCRIPTION_REQUIRED
The store does not have an active or trialing subscription.
403 STORE_API_SCOPE_REQUIRED
Token is valid but lacks the required scope for this call.
429 RATE_LIMITED
The token's request allowance is exhausted. Retry after the Retry-After header.
400 STORE_API_INVALID_REQUEST_BODY
The query or body is malformed or contains an unknown field.
404 ADMIN_REVIEW_NOT_FOUND
The review does not exist in this store.

curl -X DELETE 'https://api-store.tringify.com/api/2025-01/reviews/5ff7d4ea-3250-4a4d-9d26-07f64d917d31/response' \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/reviews/5ff7d4ea-3250-4a4d-9d26-07f64d917d31/response", {
  method: "DELETE",
  headers: {"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
});
const data = await res.json();

import requests

res = requests.delete(
    "https://api-store.tringify.com/api/2025-01/reviews/5ff7d4ea-3250-4a4d-9d26-07f64d917d31/response",
    headers={"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{"success":true,"data":{"review":{"id":"5ff7d4ea-3250-4a4d-9d26-07f64d917d31","product_id":42,"product_title":"Trailblazer Tee","rating":5,"content":"Great quality.","reviewer_name":"Avery","reviewer_email":"avery@example.com","status":"approved","verified_purchase":true,"helpful_count":2,"unhelpful_count":0,"images":[],"created_at":"2026-09-01T12:00:00Z","updated_at":"2026-09-01T12:00:00Z"}}}

Delete review

DELETE write_reviews

Permanently delete one review.

Deletes the review, its photo attachments and votes, and sends a review deletion event. Stored photo objects are reclaimed asynchronously.

Path parameters

Name	Type	Description
`id` required	`uuid`	Review id. Example: `5ff7d4ea-3250-4a4d-9d26-07f64d917d31`

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Errors

401 UNAUTHORIZED
Authorization header missing, malformed, or token invalid/expired.
402 SUBSCRIPTION_REQUIRED
The store does not have an active or trialing subscription.
403 STORE_API_SCOPE_REQUIRED
Token is valid but lacks the required scope for this call.
429 RATE_LIMITED
The token's request allowance is exhausted. Retry after the Retry-After header.
400 STORE_API_INVALID_REQUEST_BODY
The query or body is malformed or contains an unknown field.
404 ADMIN_REVIEW_NOT_FOUND
The review does not exist in this store.

curl -X DELETE 'https://api-store.tringify.com/api/2025-01/reviews/5ff7d4ea-3250-4a4d-9d26-07f64d917d31' \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/reviews/5ff7d4ea-3250-4a4d-9d26-07f64d917d31", {
  method: "DELETE",
  headers: {"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
});
const data = await res.json();

import requests

res = requests.delete(
    "https://api-store.tringify.com/api/2025-01/reviews/5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    headers={"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{"success":true,"data":{"deleted":true}}

Bulk moderate reviews

POST write_reviews

Queue approval, rejection, or hiding of selected reviews.

Returns HTTP 202 with an operation ID; acceptance does not mean the reviews have changed yet. Poll Get review bulk operation until completed or failed. Reusing operation_id with identical input returns the same operation (HTTP 200 if already finished); different input returns 409. Existing selected reviews are changed together. Missing review IDs are reported as per-review failures while valid IDs can succeed. Polling and acknowledgement require write_reviews and are restricted to the creating credential. Results remain available for 30 days after completion.

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Body parameters

Name	Type	Description
`operation_id` required	`uuid`	A new UUID for this bulk action. Reuse it only when submitting the same action after an interrupted request. Example: `7f4ed2c8-2fa5-4c63-9d9b-7ac5366dc651`
`review_ids` required	`array<uuid>`	Unique review ids, capped by bulk_max. Example: `["5ff7d4ea-3250-4a4d-9d26-07f64d917d31"]`
`status` required	`string`	approved, rejected, or hidden. Example: `approved`
`reason`	`string`	Optional moderation reason.

Errors

401 UNAUTHORIZED
Authorization header missing, malformed, or token invalid/expired.
402 SUBSCRIPTION_REQUIRED
The store does not have an active or trialing subscription.
403 STORE_API_SCOPE_REQUIRED
Token is valid but lacks the required scope for this call.
429 RATE_LIMITED
The token's request allowance is exhausted. Retry after the Retry-After header.
400 STORE_API_INVALID_REQUEST_BODY
The query or body is malformed or contains an unknown field.
400 ADMIN_REVIEW_BULK_OPERATION_INVALID
operation_id is missing or is not a valid nonzero UUID.
400 ADMIN_REVIEW_IDS_REQUIRED
No review IDs were provided.
400 ADMIN_REVIEW_DUPLICATE_ID
Review IDs must be unique.
400 ADMIN_REVIEW_BULK_LIMIT
The selection exceeds bulk_max.
409 ADMIN_REVIEW_BULK_OPERATION_CONFLICT
This operation ID was already used with different input.
400 ADMIN_REVIEW_MODERATION_STATUS_INVALID
status is not approved, rejected, or hidden.
400 ADMIN_REVIEW_MODERATION_REASON_TOO_LONG
reason exceeds moderation_reason_max_length.

curl -X POST 'https://api-store.tringify.com/api/2025-01/reviews/bulk-moderate' \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "operation_id": "7f4ed2c8-2fa5-4c63-9d9b-7ac5366dc651",
  "review_ids": [
    "5ff7d4ea-3250-4a4d-9d26-07f64d917d31"
  ],
  "status": "approved"
}'

const res = await fetch("https://api-store.tringify.com/api/2025-01/reviews/bulk-moderate", {
  method: "POST",
  headers: {"Authorization":"Bearer YOUR_STORE_API_TOKEN","Content-Type":"application/json"},
  body: JSON.stringify({
    "operation_id": "7f4ed2c8-2fa5-4c63-9d9b-7ac5366dc651",
    "review_ids": [
      "5ff7d4ea-3250-4a4d-9d26-07f64d917d31"
    ],
    "status": "approved"
  }),
});
const data = await res.json();

import requests

res = requests.post(
    "https://api-store.tringify.com/api/2025-01/reviews/bulk-moderate",
    headers={"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
    json={
        "operation_id": "7f4ed2c8-2fa5-4c63-9d9b-7ac5366dc651",
        "review_ids": ["5ff7d4ea-3250-4a4d-9d26-07f64d917d31"],
        "status": "approved",
    },
)
data = res.json()

Response

202

Sample response

{"success":true,"code":"ADMIN_REVIEWS_BULK_QUEUED","message":"Review bulk action queued.","data":{"operation":{"id":"7f4ed2c8-2fa5-4c63-9d9b-7ac5366dc651","action":"moderate","status":"queued","results":[],"created_at":"2026-09-24T04:00:00Z"}}}

Bulk delete reviews

POST write_reviews

Queue permanent deletion of selected reviews, their photos, and votes.

Returns HTTP 202 with an operation ID; acceptance does not mean the reviews have changed yet. Poll Get review bulk operation until completed or failed. Reusing operation_id with identical input returns the same operation (HTTP 200 if already finished); different input returns 409. Existing selected reviews are changed together. Missing review IDs are reported as per-review failures while valid IDs can succeed. Polling and acknowledgement require write_reviews and are restricted to the creating credential. Results remain available for 30 days after completion.

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Body parameters

Name	Type	Description
`operation_id` required	`uuid`	A new UUID for this bulk action. Reuse it only when submitting the same action after an interrupted request. Example: `7f4ed2c8-2fa5-4c63-9d9b-7ac5366dc651`
`review_ids` required	`array<uuid>`	Unique review ids, capped by bulk_max. Example: `["5ff7d4ea-3250-4a4d-9d26-07f64d917d31"]`

Errors

401 UNAUTHORIZED
Authorization header missing, malformed, or token invalid/expired.
402 SUBSCRIPTION_REQUIRED
The store does not have an active or trialing subscription.
403 STORE_API_SCOPE_REQUIRED
Token is valid but lacks the required scope for this call.
429 RATE_LIMITED
The token's request allowance is exhausted. Retry after the Retry-After header.
400 STORE_API_INVALID_REQUEST_BODY
The query or body is malformed or contains an unknown field.
400 ADMIN_REVIEW_BULK_OPERATION_INVALID
operation_id is missing or is not a valid nonzero UUID.
400 ADMIN_REVIEW_IDS_REQUIRED
No review IDs were provided.
400 ADMIN_REVIEW_DUPLICATE_ID
Review IDs must be unique.
400 ADMIN_REVIEW_BULK_LIMIT
The selection exceeds bulk_max.
409 ADMIN_REVIEW_BULK_OPERATION_CONFLICT
This operation ID was already used with different input.

curl -X POST 'https://api-store.tringify.com/api/2025-01/reviews/bulk-delete' \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "operation_id": "7f4ed2c8-2fa5-4c63-9d9b-7ac5366dc651",
  "review_ids": [
    "5ff7d4ea-3250-4a4d-9d26-07f64d917d31"
  ]
}'

const res = await fetch("https://api-store.tringify.com/api/2025-01/reviews/bulk-delete", {
  method: "POST",
  headers: {"Authorization":"Bearer YOUR_STORE_API_TOKEN","Content-Type":"application/json"},
  body: JSON.stringify({
    "operation_id": "7f4ed2c8-2fa5-4c63-9d9b-7ac5366dc651",
    "review_ids": [
      "5ff7d4ea-3250-4a4d-9d26-07f64d917d31"
    ]
  }),
});
const data = await res.json();

import requests

res = requests.post(
    "https://api-store.tringify.com/api/2025-01/reviews/bulk-delete",
    headers={"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
    json={
        "operation_id": "7f4ed2c8-2fa5-4c63-9d9b-7ac5366dc651",
        "review_ids": ["5ff7d4ea-3250-4a4d-9d26-07f64d917d31"],
    },
)
data = res.json()

Response

202

Sample response

{"success":true,"code":"ADMIN_REVIEWS_BULK_QUEUED","message":"Review bulk action queued.","data":{"operation":{"id":"7f4ed2c8-2fa5-4c63-9d9b-7ac5366dc651","action":"delete","status":"queued","results":[],"created_at":"2026-09-24T04:00:00Z"}}}

Get review bulk operation

GET write_reviews

Read a queued bulk action and its saved results.

Use the operation UUID returned when queueing the action, or current for your oldest unacknowledged action. Only the credential that created it can retrieve it. Status is queued, completed, or failed. Completed results include one entry per selected review. A failed operation saved no review changes; its error contains the backend code and message. Results remain available for 30 days after completion. current returns operation: null when nothing remains to acknowledge.

Path parameters

Name	Type	Description
`operationId` required	`string`	Operation UUID, or current for your oldest unacknowledged operation. Example: `7f4ed2c8-2fa5-4c63-9d9b-7ac5366dc651`

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Errors

401 UNAUTHORIZED
Authorization header missing, malformed, or token invalid/expired.
402 SUBSCRIPTION_REQUIRED
The store does not have an active or trialing subscription.
403 STORE_API_SCOPE_REQUIRED
Token is valid but lacks the required scope for this call.
429 RATE_LIMITED
The token's request allowance is exhausted. Retry after the Retry-After header.
404 ADMIN_REVIEW_BULK_OPERATION_NOT_FOUND
The operation does not exist, belongs to another credential, has expired, or is not finished when acknowledging.

curl 'https://api-store.tringify.com/api/2025-01/reviews/bulk-operations/7f4ed2c8-2fa5-4c63-9d9b-7ac5366dc651' \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/reviews/bulk-operations/7f4ed2c8-2fa5-4c63-9d9b-7ac5366dc651", {
  method: "GET",
  headers: {"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
});
const data = await res.json();

import requests

res = requests.get(
    "https://api-store.tringify.com/api/2025-01/reviews/bulk-operations/7f4ed2c8-2fa5-4c63-9d9b-7ac5366dc651",
    headers={"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{"success":true,"data":{"operation":{"id":"7f4ed2c8-2fa5-4c63-9d9b-7ac5366dc651","action":"moderate","status":"completed","results":[{"review_id":"5ff7d4ea-3250-4a4d-9d26-07f64d917d31","success":true}],"created_at":"2026-09-24T04:00:00Z","finished_at":"2026-09-24T04:00:01Z"}}}

Acknowledge review bulk operation

POST write_reviews

Mark a finished result as seen.

After presenting a completed or failed result, acknowledge its UUID. This removes it from current; it remains retrievable by UUID during the 30-day retention period. Repeating acknowledgement is safe. Queued operations cannot be acknowledged.

Path parameters

Name	Type	Description
`operationId` required	`uuid`	Finished operation UUID. Example: `7f4ed2c8-2fa5-4c63-9d9b-7ac5366dc651`

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Errors

401 UNAUTHORIZED
Authorization header missing, malformed, or token invalid/expired.
402 SUBSCRIPTION_REQUIRED
The store does not have an active or trialing subscription.
403 STORE_API_SCOPE_REQUIRED
Token is valid but lacks the required scope for this call.
429 RATE_LIMITED
The token's request allowance is exhausted. Retry after the Retry-After header.
404 ADMIN_REVIEW_BULK_OPERATION_NOT_FOUND
The operation does not exist, belongs to another credential, has expired, or is not finished when acknowledging.

curl -X POST 'https://api-store.tringify.com/api/2025-01/reviews/bulk-operations/7f4ed2c8-2fa5-4c63-9d9b-7ac5366dc651/acknowledge' \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/reviews/bulk-operations/7f4ed2c8-2fa5-4c63-9d9b-7ac5366dc651/acknowledge", {
  method: "POST",
  headers: {"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
});
const data = await res.json();

import requests

res = requests.post(
    "https://api-store.tringify.com/api/2025-01/reviews/bulk-operations/7f4ed2c8-2fa5-4c63-9d9b-7ac5366dc651/acknowledge",
    headers={"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{"success":true,"data":{"acknowledged":true}}

Get review settings

GET read_reviews

Fetch the store's review submission, moderation, and display settings.

Every authorized merchant or app observes the same store-scoped values.

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Errors

401 UNAUTHORIZED
Authorization header missing, malformed, or token invalid/expired.
402 SUBSCRIPTION_REQUIRED
The store does not have an active or trialing subscription.
403 STORE_API_SCOPE_REQUIRED
Token is valid but lacks the required scope for this call.
429 RATE_LIMITED
The token's request allowance is exhausted. Retry after the Retry-After header.

curl 'https://api-store.tringify.com/api/2025-01/reviews/settings' \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/reviews/settings", {
  method: "GET",
  headers: {"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
});
const data = await res.json();

import requests

res = requests.get(
    "https://api-store.tringify.com/api/2025-01/reviews/settings",
    headers={"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{"success":true,"data":{"settings":{"moderation_mode":"auto_approve","blocked_words":[],"block_urls":true,"block_emails":true,"flag_low_ratings":false,"require_purchase":false,"review_request_delay_days":3,"allow_anonymous":false,"auto_approve_guest_reviews":false,"allow_images":true,"max_images":3,"min_content_length":20,"max_content_length":1000,"reviewer_display":"first_name","enable_responses":true}}}

Update review settings

PUT write_review_settings

Patch review submission, moderation, and display settings.

Omitted fields remain unchanged. Content filters apply on their own: each one that is on refuses matching submissions, whatever the moderation mode. require_purchase and allow_anonymous cannot both be true. The minimum content length must be less than the maximum.

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Body parameters

Name	Type	Description
`moderation_mode`	`string`	auto_approve publishes each review that passes the content filters as soon as it is submitted, unless flag_low_ratings holds it for approval; manual keeps every review pending until it is approved; disabled stops new reviews and helpful votes and hides existing reviews from the storefront. Default auto_approve. Example: `manual`
`blocked_words`	`array<string>`	Complete blocked word list. A submission containing any of these words or phrases, in its title, text or reviewer name, is refused with STORE_REVIEW_BLOCKED_WORDS. Default []. Example: `["spam"]`
`block_urls`	`boolean`	Refuse submissions whose title, text or reviewer name contains a web address, with STORE_REVIEW_LINKS_NOT_ALLOWED. Default true. Example: `true`
`block_emails`	`boolean`	Refuse submissions whose title, text or reviewer name contains an email address, with STORE_REVIEW_EMAILS_NOT_ALLOWED. Default true. Example: `true`
`flag_low_ratings`	`boolean`	In auto_approve mode, keep 1- and 2-star reviews pending until they are approved. Has no effect in manual mode, where every review is pending. Default false. Example: `true`
`require_purchase`	`boolean`	Accept reviews only from customers whose order for the product counts as a purchase (paid, cash on delivery, or partly or fully refunded; never cancelled or test orders), or from a review invitation. Cannot be true while allow_anonymous is true. Default false. Example: `false`
`review_request_delay_days`	`integer`	Days after an order is fully delivered before the review request is sent (0-60). Default 3. Example: `7`
`allow_anonymous`	`boolean`	Accept reviews from guests who are not signed in. Guests must enter a name. Invited customers can always review what they bought. Default false. Example: `true`
`auto_approve_guest_reviews`	`boolean`	Let guest reviews follow moderation_mode like customers' reviews. While false, every guest review is pending until approved. Default false. Example: `false`
`allow_images`	`boolean`	Allow review photos. Default true. Example: `true`
`max_images`	`integer`	Maximum photos per review, from 1 through max_images_max. Default 3. Example: `5`
`min_content_length`	`integer`	Minimum review text length, in characters. Default 20. Example: `10`
`max_content_length`	`integer`	Maximum review text length, in characters. Default 1000. Example: `5000`
`reviewer_display`	`string`	How reviewer names appear on the storefront: anonymous, first_name, full_name, or initials. Default first_name. Example: `first_name`
`enable_responses`	`boolean`	Allow public store responses to reviews. Default true. Example: `true`

Errors

401 UNAUTHORIZED
Authorization header missing, malformed, or token invalid/expired.
402 SUBSCRIPTION_REQUIRED
The store does not have an active or trialing subscription.
403 STORE_API_SCOPE_REQUIRED
Token is valid but lacks the required scope for this call.
429 RATE_LIMITED
The token's request allowance is exhausted. Retry after the Retry-After header.
400 STORE_API_INVALID_REQUEST_BODY
The query or body is malformed or contains an unknown field.
400 ADMIN_REVIEW_SETTINGS_MODERATION_MODE_INVALID
moderation_mode is not supported.
400 ADMIN_REVIEW_SETTINGS_MAX_IMAGES_RANGE
max_images is outside the supported range.
400 ADMIN_REVIEW_SETTINGS_MIN_CONTENT_LENGTH_RANGE
min_content_length is outside the supported range.
400 ADMIN_REVIEW_SETTINGS_MAX_CONTENT_LENGTH_RANGE
max_content_length is outside the supported range.
400 ADMIN_REVIEW_SETTINGS_CONTENT_LENGTH_ORDER_INVALID
Minimum content length must be below maximum content length.
400 ADMIN_REVIEW_SETTINGS_REVIEWER_DISPLAY_INVALID
reviewer_display is not supported.
400 ADMIN_REVIEW_SETTINGS_BLOCKED_WORDS_LIMIT
blocked_words exceeds the count or entry-length limit.
400 ADMIN_REVIEW_SETTINGS_PURCHASE_ANONYMOUS_CONFLICT
require_purchase and allow_anonymous cannot both be true.
400 ADMIN_REVIEW_SETTINGS_REQUEST_DELAY_RANGE
review_request_delay_days must be from 0 through 60.

curl -X PUT 'https://api-store.tringify.com/api/2025-01/reviews/settings' \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "allow_anonymous": true,
  "allow_images": true,
  "auto_approve_guest_reviews": false,
  "block_emails": true,
  "block_urls": true,
  "blocked_words": [
    "spam"
  ],
  "enable_responses": true,
  "flag_low_ratings": true,
  "max_content_length": 5000,
  "max_images": 5,
  "min_content_length": 10,
  "moderation_mode": "manual",
  "require_purchase": false,
  "review_request_delay_days": 7,
  "reviewer_display": "first_name"
}'

const res = await fetch("https://api-store.tringify.com/api/2025-01/reviews/settings", {
  method: "PUT",
  headers: {"Authorization":"Bearer YOUR_STORE_API_TOKEN","Content-Type":"application/json"},
  body: JSON.stringify({
    "allow_anonymous": true,
    "allow_images": true,
    "auto_approve_guest_reviews": false,
    "block_emails": true,
    "block_urls": true,
    "blocked_words": [
      "spam"
    ],
    "enable_responses": true,
    "flag_low_ratings": true,
    "max_content_length": 5000,
    "max_images": 5,
    "min_content_length": 10,
    "moderation_mode": "manual",
    "require_purchase": false,
    "review_request_delay_days": 7,
    "reviewer_display": "first_name"
  }),
});
const data = await res.json();

import requests

res = requests.put(
    "https://api-store.tringify.com/api/2025-01/reviews/settings",
    headers={"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
    json={
        "allow_anonymous": True,
        "allow_images": True,
        "auto_approve_guest_reviews": False,
        "block_emails": True,
        "block_urls": True,
        "blocked_words": ["spam"],
        "enable_responses": True,
        "flag_low_ratings": True,
        "max_content_length": 5000,
        "max_images": 5,
        "min_content_length": 10,
        "moderation_mode": "manual",
        "require_purchase": False,
        "review_request_delay_days": 7,
        "reviewer_display": "first_name",
    },
)
data = res.json()

Response

200

Sample response

{"success":true,"data":{"settings":{"moderation_mode":"auto_approve","blocked_words":[],"block_urls":true,"block_emails":true,"flag_low_ratings":false,"require_purchase":false,"review_request_delay_days":3,"allow_anonymous":false,"auto_approve_guest_reviews":false,"allow_images":true,"max_images":3,"min_content_length":20,"max_content_length":1000,"reviewer_display":"first_name","enable_responses":true}}}

Review submitted

EVENT reviews/create App scope: read_reviews Staff permission: reviews:write

Fired when a shopper submits a product review. Submissions refused by the content filters are not saved and do not fire it. The review's status shows whether it was published or is waiting for approval.

Payload fields

Field	Type	Description
`review.id`	`string`	Always present
`review.product_id`	`integer`	Selectable in the Payload builder
`review.variant_id`	`integer`	Selectable in the Payload builder
`review.rating`	`integer`	Selectable in the Payload builder
`review.title`	`string`	Selectable in the Payload builder
`review.content`	`string`	Selectable in the Payload builder
`review.reviewer_name`	`string`	Selectable in the Payload builder
`review.status`	`string`	Selectable in the Payload builder
`review.moderation_reason`	`string`	Selectable in the Payload builder
`review.verified_purchase`	`boolean`	Selectable in the Payload builder
`review.helpful_count`	`integer`	Selectable in the Payload builder
`review.unhelpful_count`	`integer`	Selectable in the Payload builder
`review.store_response`	`string`	Selectable in the Payload builder
`review.images[*].id`	`string`	Always present
`review.images[*].url`	`string`	Selectable in the Payload builder
`review.images[*].width`	`integer`	Selectable in the Payload builder
`review.images[*].height`	`integer`	Selectable in the Payload builder
`review.images[*].sort_order`	`integer`	Selectable in the Payload builder
`review.created_at`	`string`	Selectable in the Payload builder
`review.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "review": {
    "content": "The shirt fits well and arrived as described.",
    "created_at": "2026-06-09T12:00:00+05:30",
    "helpful_count": 2,
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "images": [],
    "moderation_reason": null,
    "product_id": 42,
    "rating": 4,
    "reviewer_name": "Avery",
    "status": "approved",
    "store_response": null,
    "title": "Comfortable fit",
    "unhelpful_count": 0,
    "updated_at": "2026-06-09T12:00:00+05:30",
    "variant_id": null,
    "verified_purchase": true
  }
}

Review updated

EVENT reviews/update App scope: read_reviews Staff permission: reviews:write

Fired when review moderation or the store response changes.

Payload fields

Field	Type	Description
`review.id`	`string`	Always present
`review.product_id`	`integer`	Selectable in the Payload builder
`review.variant_id`	`integer`	Selectable in the Payload builder
`review.rating`	`integer`	Selectable in the Payload builder
`review.title`	`string`	Selectable in the Payload builder
`review.content`	`string`	Selectable in the Payload builder
`review.reviewer_name`	`string`	Selectable in the Payload builder
`review.status`	`string`	Selectable in the Payload builder
`review.moderation_reason`	`string`	Selectable in the Payload builder
`review.verified_purchase`	`boolean`	Selectable in the Payload builder
`review.helpful_count`	`integer`	Selectable in the Payload builder
`review.unhelpful_count`	`integer`	Selectable in the Payload builder
`review.store_response`	`string`	Selectable in the Payload builder
`review.images[*].id`	`string`	Always present
`review.images[*].url`	`string`	Selectable in the Payload builder
`review.images[*].width`	`integer`	Selectable in the Payload builder
`review.images[*].height`	`integer`	Selectable in the Payload builder
`review.images[*].sort_order`	`integer`	Selectable in the Payload builder
`review.created_at`	`string`	Selectable in the Payload builder
`review.updated_at`	`string`	Selectable in the Payload builder
`changed_fields`	`array`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "changed_fields": [
    "status",
    "moderation_reason"
  ],
  "review": {
    "content": "The shirt fits well and arrived as described.",
    "created_at": "2026-06-09T12:00:00+05:30",
    "helpful_count": 2,
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "images": [],
    "moderation_reason": null,
    "product_id": 42,
    "rating": 4,
    "reviewer_name": "Avery",
    "status": "approved",
    "store_response": null,
    "title": "Comfortable fit",
    "unhelpful_count": 0,
    "updated_at": "2026-06-09T12:00:00+05:30",
    "variant_id": null,
    "verified_purchase": true
  }
}

Review deleted

EVENT reviews/delete App scope: read_reviews Staff permission: reviews:write

Fired when a product review is deleted.

Payload fields

Field	Type	Description
`review.id`	`string`	Always present
`review.product_id`	`integer`	Selectable in the Payload builder
`review.rating`	`integer`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "review": {
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "product_id": 42,
    "rating": 4
  }
}

Review settings updated

EVENT review_settings/update App scope: read_reviews Staff permission: reviews:write

Fired when product review settings change.

Payload fields

Field	Type	Description
`settings.moderation_mode`	`string`	Selectable in the Payload builder
`settings.blocked_words`	`array`	Selectable in the Payload builder
`settings.block_urls`	`boolean`	Selectable in the Payload builder
`settings.block_emails`	`boolean`	Selectable in the Payload builder
`settings.flag_low_ratings`	`boolean`	Selectable in the Payload builder
`settings.require_purchase`	`boolean`	Selectable in the Payload builder
`settings.allow_anonymous`	`boolean`	Selectable in the Payload builder
`settings.auto_approve_guest_reviews`	`boolean`	Selectable in the Payload builder
`settings.allow_images`	`boolean`	Selectable in the Payload builder
`settings.max_images`	`integer`	Selectable in the Payload builder
`settings.min_content_length`	`integer`	Selectable in the Payload builder
`settings.max_content_length`	`integer`	Selectable in the Payload builder
`settings.review_request_delay_days`	`integer`	Selectable in the Payload builder
`settings.reviewer_display`	`string`	Selectable in the Payload builder
`settings.enable_responses`	`boolean`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "settings": {
    "allow_anonymous": true,
    "allow_images": true,
    "auto_approve_guest_reviews": false,
    "block_emails": true,
    "block_urls": true,
    "blocked_words": [],
    "enable_responses": true,
    "flag_low_ratings": true,
    "max_content_length": 5000,
    "max_images": 5,
    "min_content_length": 10,
    "moderation_mode": "manual",
    "require_purchase": false,
    "review_request_delay_days": 3,
    "reviewer_display": "first_name"
  }
}

Endpoints#

Headers

Errors

Query parameters

Headers

Errors

Path parameters

Headers

Errors

Path parameters

Headers

Body parameters

Errors

Path parameters

Headers

Body parameters

Errors

Path parameters

Headers

Errors

Path parameters

Headers

Errors

Headers

Body parameters

Errors

Headers

Body parameters

Errors

Path parameters

Headers

Errors

Path parameters

Headers

Errors

Headers

Errors

Headers

Body parameters

Errors

Webhook events#

Payload fields

Payload fields

Payload fields

Payload fields