Get the current customer's review of a product

GET

/cms/product/{id}/reviews/mine

const url = 'https://api.example.com/cms/product/1/reviews/mine';
const options = {
  method: 'GET',
  headers: {'API-Key': '<API-Key>', Authorization: 'Bearer <token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.example.com/cms/product/1/reviews/mine \
  --header 'API-Key: <API-Key>' \
  --header 'Authorization: Bearer <token>'

Returns the review in any moderation status, or null. When there is none, can_review and reason tell whether the customer may submit one.

Authorizations

ApiKeyAuth
CustomerAuth

Parameters

Path Parameters

required

integer

Responses

200

Review status for the customer

application/json

object

review

One of:

Product Review

Product Review

A customer review of a product. Only approved reviews are listed publicly.

object

Review ID

integer format: int64

product_id

Product ID

integer format: int64

author_name

Public name of the reviewer (nickname, display name, or first and last name)

string

rating

Rating

integer

>= 1 <= 5

body

Review text (plain text)

string

status

Moderation status

string

Allowed values: pending approved declined

timestamp

Submission date

string format: date-time

last_edited

Last edit by the customer

string format: date-time

nullable

can_review

boolean

reason

string

nullable

Allowed values: REVIEWS_DISABLED REVIEW_ALREADY_EXISTS PURCHASE_REQUIRED

Example

{
  "review": {
    "status": "pending"
  },
  "reason": "REVIEWS_DISABLED"
}

404

Product not found or not available