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
| Method | Path | What it does |
|---|---|---|
GET | /v1/reviews | List reviews |
GET | /v1/reviews/{reviewId} | Get review |
POST | /v1/reviews/{reviewId}/replies | Reply to a review |
All require Authorization: Bearer mk_your_api_key. See Authentication.
What is rated: subject
subject | Meaning |
|---|---|
product | the product (links to a listingId) |
sale | the sale (links to an orderId) |
seller | the 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 is8000; positive is10000, neutral5000and negative0.originalRating: the rating as the marketplace gave it, stars (valueandmax) 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
subjectdoes not accept replies:422CAPABILITY_UNSUPPORTED; - a reply already exists:
409review_already_replied; - the deadline (
replyDeadlineAt) has passed:409review_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.