Reviews

Product reviews, moderation and settings

📄️ List reviews

Returns a paginated list of reviews for the store. Also publicly accessible for storefronts: unauthenticated (customer) requests only receive published reviews (`isReviewed: true`) with a reduced projection (`rating`, `reviewer`, `review`, `image`). Authenticated vendor requests receive the full review documents with `products` populated as `{ id, title }`.

📄️ Export reviews

Exports all of the store's reviews as an Excel workbook (`Reviews-<storeName>.xlsx`), returned as a file attachment.

📄️ Get review settings

Returns the store's review settings (auto-publish, automatic review-request scheduling, reward-on-approval, moderation, media uploads, language). Settings are created with defaults on first read.

📄️ Update review settings

Partially updates the store's review settings. All fields are optional; only provided keys are changed. Saving any auto-request field also re-syncs the scheduled review-request automation.

📄️ Get review analytics

Returns aggregate review statistics for the store: totals, average rating, helpful votes, counts by status and rating, media count, and the five most recent reviews. `startDate`/`endDate` are accepted by validation but the aggregation currently covers all reviews.

📄️ Get a review

Returns a single review by id.

📄️ Update a review

Updates review content (rating, reviewer, products, text, media, date). Moderation `status` cannot be changed here — use the `/review/{reviewId}/moderate` endpoint, which also handles publishing and reward granting.

📄️ Delete a review

Permanently deletes a review.

📄️ Moderate a review

Approves or rejects a review. Approval publishes the review and, when the store's reward settings are enabled and the review is a verified purchase, grants a single-use reward coupon to the reviewer.

📄️ Reply to a review

Adds or replaces the merchant's public reply on a review. The reply records the replying user and timestamp.

📄️ Send a manual review request

Sends an on-demand review request for a single order — the manual counterpart to the scheduled review-request automation. The order must be fulfilled or delivered, have a customer, and not already have a review or a prior review request (conflicts return 409). Channel defaults to the store's auto-request channel, then EMAIL.