API Documentation
Authentication APIs
- Login & Register
- Create & Manage Users
Catalog APIs
- GETList all products
- GETList all skus
- GETRetrieve a product
- GETRetrieve product variants
- GETRetrieve variant detail
- GETList all categories
- GETRetrieve product reviews
- POSTCreate product review
- GETRetrieve similar products
- GETRetrieve up sell products
- GETRetrieve cross sell products
- GETRetrieve recommended products
- POSTDatocms webhook
Cart & Checkout APIs
- Cart
- Checkout
Coupons & promotions API
Customers API
Orders APIs
Shipping APIs
Analytics
Campaigns API
Catalog APIs
Retrieve product reviews
GET
/
catalog
/
products
/
{product_id}
/
reviews
curl --request GET \
--url https://services.commercengine.dev/api/v1/x2yh61zw4k/admin/catalog/products/{product_id}/reviews \
--header 'Authorization: Bearer <token>'
{
"message": "<string>",
"success": true,
"content": {
"reviews": [
{
"id": 123,
"product_id": "<string>",
"rating": 123,
"review_text": "<string>",
"name": "<string>",
"email": "<string>",
"status": "Pending",
"is_featured": true,
"tags": [
"<string>"
],
"images": [
{
"id": 123,
"title": "<string>",
"alternate_text": "<string>",
"sort_order": 123,
"url_tiny": "<string>",
"url_thumbnail": "<string>",
"url_standard": "<string>",
"url_zoom": "<string>",
"other_details": {}
}
],
"videos": [
{
"title": "<string>",
"cover_image_url": "<string>",
"video_preview_url": "<string>",
"sort_order": 123,
"other_details": {}
}
],
"review_date": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z"
}
],
"pagination": {
"total_records": 123,
"total_pages": 123,
"previous_page": "<any>",
"limit": 123,
"next_page": "<any>"
}
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
product Ulid
Query Parameters
page number of pagination list
Required range:
x > 1
no of rows per page
Required range:
x > 1
JSON string format: {"field1":"asc", "field2":"desc"}
search keyword
JSON - array of objects
Response
200 - application/json
OK
Maximum length:
128
Maximum length:
128
Available options:
Pending
, Approved
, Rejected
, Archived
Maximum length:
128
Maximum length:
128
Maximum length:
512
Maximum length:
512
Maximum length:
512
Maximum length:
512
curl --request GET \
--url https://services.commercengine.dev/api/v1/x2yh61zw4k/admin/catalog/products/{product_id}/reviews \
--header 'Authorization: Bearer <token>'
{
"message": "<string>",
"success": true,
"content": {
"reviews": [
{
"id": 123,
"product_id": "<string>",
"rating": 123,
"review_text": "<string>",
"name": "<string>",
"email": "<string>",
"status": "Pending",
"is_featured": true,
"tags": [
"<string>"
],
"images": [
{
"id": 123,
"title": "<string>",
"alternate_text": "<string>",
"sort_order": 123,
"url_tiny": "<string>",
"url_thumbnail": "<string>",
"url_standard": "<string>",
"url_zoom": "<string>",
"other_details": {}
}
],
"videos": [
{
"title": "<string>",
"cover_image_url": "<string>",
"video_preview_url": "<string>",
"sort_order": 123,
"other_details": {}
}
],
"review_date": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z"
}
],
"pagination": {
"total_records": 123,
"total_pages": 123,
"previous_page": "<any>",
"limit": 123,
"next_page": "<any>"
}
}
}