Reviews

Overview

What a review is, how to read the rating and when a reply is refused.

A review is the rating a buyer gives after the purchase. The seller can reply once, within a deadline.

How customer service works end to end: Serve buyers.

Endpoints

MethodPathWhat it does
GET/v1/reviewsList reviews
GET/v1/reviews/{reviewId}Get review
POST/v1/reviews/{reviewId}/repliesReply to a review

All require Authorization: Bearer mk_your_api_key. See Authentication.

What is rated: subject

subjectMeaning
productthe product (links to a listingId)
salethe sale (links to an orderId)
sellerthe seller as a whole

The rating

Marketplaces use different scales. The API gives you two things:

  • ratingBps: the rating in basis points, the same for everyone. 4 of 5 stars is 8000; positive is 10000, neutral 5000 and negative 0.
  • originalRating: the rating as the marketplace gave it, stars (value and max) or sentiment.

Filter by rating with maxRatingBps in List reviews.

Replying

Reply to a review returns 202 with a job. The API refuses before the job when:

  • the subject does not accept replies: 422 CAPABILITY_UNSUPPORTED;
  • a reply already exists: 409 review_already_replied;
  • the deadline (replyDeadlineAt) has passed: 409 review_reply_window_closed.

Webhook

review.received arrives when a new review comes in. It carries ids and the rating only (reviewId, subject, ratingBps…), never the text. Read the text with Get review. See Receiving webhooks.