Kanorio
Kanorio 开发者

API 参考

Reviews

Content Delivery API: GET /reviews, GET /reviews/summary

本页只有英文版。API 参考、Webhook 事件和更新日志保持英文，与代码中的字段名称、错误码一致。
Base URL https://{site}/api/v1ErrorsPagination

Approved reviews for a product

GET/reviews
betaNo auth

Newest first, cursor-paginated. Only approved and published reviews are returned; 404 when the target does not exist, is not published, or has reviews turned off. verified is true only for reviews tied to a paid order (imported reviews are never verified).

Parameters

  • targetstring · queryrequired

    product:<id>

  • cursorstring · query

    Opaque cursor from the previous page's nextCursor. Omit for the first page.

  • limitinteger · query

    Maximum number of items to return, 1-100. Defaults to 20.

Response 200

  • dataobject[]required
  • data[].idstringrequired
  • data[].authorNamestringrequired
  • data[].ratingintegerrequired
  • data[].contentstringrequired
  • data[].publishedAtstringrequired
  • data[].verifiedbooleanrequired

    True when the review is tied to a paid order; imported reviews are never verified.

  • data[].replyobjectrequired

    The store's public reply, if any.

  • data[].reply.bodystringrequired
  • data[].reply.repliedAtstringrequired
  • hasMorebooleanrequired
  • nextCursorstring | nullrequired
  • hasHistoricalRatingbooleanrequired

    True when the overall rating blends in reviews carried over from another platform.

Errors

  • VALIDATION 400
  • INVALID_CURSOR 400
curl -X GET "https://{site}/api/v1/reviews"

Rating summary for a product

GET/reviews/summary
betaNo auth

The blended average rating and the number of reviews, after the store's visibility rule (for example “show once there are 10 reviews”). When visible is false, render nothing.

Parameters

  • targetstring · queryrequired

    product:<id>

Response 200

  • targetstringrequired

    product:<id>

  • ratingnumberrequired

    Blended average, 1–5; null when hidden.

  • countintegerrequired

    Reviews counted toward the rating; 0 when hidden.

  • visiblebooleanrequired

    False when the store hides the rating (disabled or below its threshold).

  • hasHistoricalRatingbooleanrequired

Errors

  • VALIDATION 400
curl -X GET "https://{site}/api/v1/reviews/summary"