Auth
- POSTAnonymous user
- POSTLogin with phone
- POSTLogin with email
- POSTLogin with whatsapp
- POSTLogin with password
- POSTVerify OTP
- POSTRegister with phone
- POSTRegister with email
- POSTRegister with whatsapp
- POSTRegister with password
- GETRetrieve a user
- PUTUpdate a user
- GETRetrieve a profile image
- PUTUpdate profile image
- POSTAdd profile image
- DELDelete profile image
- PUTDeactivate account
- POSTRefresh access token
- POSTChange password
- POSTForgot password
- POSTReset password
- GETRetrieve user notification preferences
- PUTUpdate user notification preferences
- POSTCreate user notification preferences
- POSTGenerate OTP
- POSTLogout user
- POSTCheck email/phone verification status
Catalog
Carts
- POSTCreate cart
- GETRetrieve cart detail
- DELDelete cart
- GETRetrieve cart using user id
- DELDelete cart using user id
- POSTAdd/delete cart item
- POSTUpdate cart address
- POSTApply coupon
- DELRemove coupon
- POSTRedeem loyalty points
- DELRemove loyalty points
- POSTUse credit balance
- DELRemove credit balance
- POSTRedeem gift card
- DELRemove gift card
- GETRetrieve wishlist
- POSTAdd product to wishlist
- DELDelete product from wishlist
Coupons & promotions
Customers
Orders
Shipping
Analytics
Campaigns
List all product reviews
List of reviews for a specified product. The reviews are returned sorted by submission date, with the most recent reviews appearing first. You can filter the reviews by rating, reviewer, or date for more detailed analysis.
curl --request GET \
--url https://staging.api.commercengine.io/api/v1/{store_id}/storefront/catalog/products/{product_id}/reviews \
--header 'Authorization: Bearer <token>'
{
"message": "<string>",
"success": true,
"content": {
"reviews": [
{
"rating": 3,
"review_text": "<string>",
"name": "<string>",
"email": "[email protected]",
"status": "pending",
"is_featured": false,
"tags": [
"<string>"
],
"review_date": "2023-11-07T05:31:56Z",
"images": [
{
"blur_url": "<string>",
"thumbnail_url": "<string>",
"standard_url": "<string>"
}
],
"videos": [
{
"cover_image_url": "<string>",
"video_preview_url": "<string>",
"playback": {
"hls": "<string>",
"dash": "<string>"
},
"duration": "<string>",
"size": "<string>"
}
],
"created_at": "2023-05-25T14:15:22Z",
"modified_at": "2023-05-25T14:15:22Z"
}
],
"review_tags": [
"<string>"
],
"pagination": {
"total_records": 252,
"total_pages": 26,
"previous_page": null,
"next_page": 2,
"limit": 10
}
}
}
Authorizations
Access token
Path Parameters
id of a particular product
Query Parameters
page number of pagination list
x >= 1
no of rows per page
x >= 1
JSON string format: {"field1":"asc", "field2":"desc"}
"{\"country\":\"asc\",\"city\":\"asc\",\"population\":\"desc\"}"
search keyword
filter review with review tag
Response
The rating of the product review. Must be in rang 1-5 (multiple of 0.5)
1 <= x <= 5
Must be a multiple of 0.5
The text for the product review.
The name of the reviewer.
The email of the reviewer. Must be a valid email, or an empty string.
Reviews with approved status will be displayed.
approved
, rejected
, archived
, pending
The ISO 8601 date-time for when review was first submitted or last modified by the original submitter.
The ISO 8601 date-time for when review is created.
"2023-05-25T14:15:22Z"
The ISO 8601 date-time for when review was last modified.
"2023-05-25T14:15:22Z"
pagination metadata structure
{
"total_records": 252,
"total_pages": 26,
"previous_page": null,
"next_page": 2,
"limit": 10
}
curl --request GET \
--url https://staging.api.commercengine.io/api/v1/{store_id}/storefront/catalog/products/{product_id}/reviews \
--header 'Authorization: Bearer <token>'
{
"message": "<string>",
"success": true,
"content": {
"reviews": [
{
"rating": 3,
"review_text": "<string>",
"name": "<string>",
"email": "[email protected]",
"status": "pending",
"is_featured": false,
"tags": [
"<string>"
],
"review_date": "2023-11-07T05:31:56Z",
"images": [
{
"blur_url": "<string>",
"thumbnail_url": "<string>",
"standard_url": "<string>"
}
],
"videos": [
{
"cover_image_url": "<string>",
"video_preview_url": "<string>",
"playback": {
"hls": "<string>",
"dash": "<string>"
},
"duration": "<string>",
"size": "<string>"
}
],
"created_at": "2023-05-25T14:15:22Z",
"modified_at": "2023-05-25T14:15:22Z"
}
],
"review_tags": [
"<string>"
],
"pagination": {
"total_records": 252,
"total_pages": 26,
"previous_page": null,
"next_page": 2,
"limit": 10
}
}
}