Kanorio
Kanorio 開発者

API リファレンス

Reviews

Customer API: GET /reviews, POST /reviews, PATCH /reviews

このページは英語のみです。API リファレンス、Webhook イベント、変更履歴は、コード内のフィールド名やエラーコードと揃えるため英語で提供しています。
Base URL https://{site}/api/v1/customerErrorsPagination

The customer's own reviews on the given order lines

GET/reviews
beta

Returns a map keyed by order line id. Order lines without a review from this customer are omitted. Use it to decide whether to show a “write a review” or “edit your review” button.

Parameters

  • orderItemIdsstring · queryrequired

    Comma-separated order line ids (max 100).

Response 200

  • data"PENDING" | "APPROVED" | "REJECTED"[]required
  • hasMorebooleanrequired

    True when another page exists; pass nextCursor to fetch it.

  • nextCursorstring | nullrequired

    Cursor for the next page, or null on the last page.

Errors

  • VALIDATION 400
curl -X GET "https://{site}/api/v1/customer/reviews" \
  -H "Authorization: Bearer $KANORIO_CUSTOMER_TOKEN"

Submit a review for a paid order line

POST/reviews
beta

Eligibility is checked by the store: the order line must belong to this customer and be paid (digital products also need a live entitlement). The review starts as PENDING until the store approves it. One review per order line.

Request body

  • orderItemIdstringrequired

    Order line id from GET /orders/{id}.

  • ratingintegerrequired
  • contentstring

Response 200

  • reviewIdstring
  • status"PENDING" | "APPROVED" | "REJECTED"required

Errors

  • ORDER_NOT_FOUND 404
  • FORBIDDEN 403
  • REVIEWS_DISABLED 403
  • ALREADY_REVIEWED 409
  • VALIDATION 400
curl -X POST "https://{site}/api/v1/customer/reviews" \
  -H "Authorization: Bearer $KANORIO_CUSTOMER_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

Edit the customer's own review

PATCH/reviews
beta

Only reviews written by this customer can be edited. An edited review goes back to PENDING and is re-moderated by the store.

Request body

  • reviewIdstringrequired
  • ratingintegerrequired
  • contentstring

Response 200

  • reviewIdstring
  • status"PENDING" | "APPROVED" | "REJECTED"required

Errors

  • NOT_FOUND 404
  • FORBIDDEN 403
  • VALIDATION 400
curl -X PATCH "https://{site}/api/v1/customer/reviews" \
  -H "Authorization: Bearer $KANORIO_CUSTOMER_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'