List Reviews
GETv1/managers/store/reviews/product/This API endpoint retrieves a list of product reviews. It allows you to filter and paginate through reviews based on various query parameters such as the review status, date range, and customer ID.
Request
The page number of the results.
Number of results per page.
A term to search within the review content.
Filter reviews based on status.
Filter reviews starting from a specific date.
Filter reviews up to a specific date.
Filter reviews by a specific customer ID.
Sort results in ascending (asc) or descending (desc) order.
The field by which the reviews should be ordered.
Specifies the Media Types acceptable for the client. In this case, it signals that the client expects a response in the JSON format.
The Authorization token is a unique key given to the third-party application (Partner) by Zid. It is used to authenticate the API requests made by the Partner application. The token verifies the partner's identity and ensures they have permission to access Zid's API but does not provide any specific user or store information. It should be included in the header of API requests when the partner application needs to access Zid's API.
The User-Agent header contains information about the user agent (browser or app) making the request. It allows the server to provide a tailored response depending on the user agent's capabilities and preferences.
This token is used to authenticate and access information related to the store. It is obtained through an OAuth mechanism and is required to perform operations on the store's data. The X-Manager-Token should be included in the header of API requests that require store-related information.
Preferred language for the response. Defaults to en if not specified.
Request samples
Responses
Contains the overall status of the request.
Information about the paginated results.
The current page number.
The next page number.
The total number of pages available.
The total number of reviews returned in this response.
A list of review objects.
The unique identifier for the review.
Details of the customer who submitted the review.
Information about the reviewed product.
The status of the review (e.g., approved, pending).
Indicates whether the review was submitted anonymously.
The rating given by the customer (1 to 5 stars).
The content of the review comment.
The reply to the review, if any.
List of image URLs associated with the review.
The date and time the review was created.
The date and time the review was last updated.
Any messages related to the request.
The type of message.
A message code, if applicable.
The name associated with the message.
A detailed description of the message.
{
"status": "object",
"pagination": {
"page": 1,
"next_page": 2,
"last_page": 14,
"result_count": 28
},
"reviews": [
{
"id": "a9083b5c-7eba-464a-9c9c-9c8c5d9f9e6f",
"customer": {
"id": 38990,
"name": "check"
},
"product": {
"id": "561c3fe5-a357-4973-9928-8a307f974dae",
"name": "test22",
"bought_this_item": false,
"image": null
},
"status": "approved",
"is_anonymous": false,
"rating": 3,
"comment": "Ahshssh",
"reply": null,
"images": [],
"created_at": "2024-09-04 12:34:14",
"updated_at": "2024-10-07 06:13:02"
},
{
"id": "3adaa670-3278-4a27-a11c-9c48804ca207",
"customer": {
"id": 214,
"name": "mohamed2"
},
"product": {
"id": "f9d02d0d-ea79-4bf3-865e-a735826f14a0",
"name": "test 55",
"bought_this_item": true,
"image": null
},
"status": "approved",
"is_anonymous": false,
"rating": 1,
"comment": "test 2 images<br />test new",
"reply": {
"id": "c48a3ec2-d234-498f-9c83-e987f7563bec",
"text": "dvxcvxcv 😂🤣🙃",
"images": [
{
"path": "https://zid-testing-907587157081.s3.eu-west-1.amazonaws.com/52e981e7-7f49-441e-87ee-f4512bcf7121/8c619c39-f803-4e60-9bf9-fdeacaf3319a.jpg"
},
{
"path": "https://zid-testing-907587157081.s3.eu-west-1.amazonaws.com/52e981e7-7f49-441e-87ee-f4512bcf7121/63ce6f77-c819-4c47-8c1c-6b2f2516a85c.jpg"
},
{
"path": "https://zid-testing-907587157081.s3.eu-west-1.amazonaws.com/52e981e7-7f49-441e-87ee-f4512bcf7121/b6894238-bc8f-43be-aaef-7579bef54a70.jpg"
}
],
"created_at": "2024-08-12 13:07:04",
"updated_at": "2024-08-12 14:07:22"
},
"images": [
{
"path": "https://zid-testing-907587157081.s3.eu-west-1.amazonaws.com/52e981e7-7f49-441e-87ee-f4512bcf7121/6da8a689-5536-46ff-8248-0afcd44af256.jpg"
},
{
"path": "https://zid-testing-907587157081.s3.eu-west-1.amazonaws.com/52e981e7-7f49-441e-87ee-f4512bcf7121/d5eccda8-9fac-4ad3-a533-3cf681d2362b.jpg"
}
],
"created_at": "2024-08-05 20:25:38",
"updated_at": "2024-10-07 06:12:49"
}
],
"message": {
"type": "object",
"code": null,
"name": null,
"description": null
}
}