# List Reviews ## OpenAPI Specification ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /v1/managers/store/reviews/{type}: get: summary: List Reviews deprecated: false description: >- Retrieves a list of customer reviews for a specified product within a store. Use this endpoint to fetch all available reviews based on the `PRODUCT_ID` and `STORE_ID`. `products.read` - Products Read tags: - Default module/Apps/Merchant APIs/Products/Product Reviews parameters: - name: type in: path description: '' required: true example: product schema: type: string enum: - product x-apidog-enum: - value: product name: '' description: '' - name: page in: query description: >- Specifies the page number of results to retrieve. Use this to navigate through paginated reviews. required: false example: '1' schema: type: string - name: page_size in: query description: ' Defines the number of reviews to return per page. Use this parameter to limit the results in each response.' required: false example: '3' schema: type: string - name: status in: query description: '' required: false example: approved schema: type: string enum: - pending - approved - rejected - spam x-apidog-enum: - value: pending name: '' description: '' - value: approved name: '' description: '' - value: rejected name: '' description: '' - value: spam name: '' description: '' - name: search_term in: query description: '' required: false schema: type: string - name: date_from in: query description: '' required: false schema: type: string - name: date_to in: query description: '' required: false schema: type: string - name: order_by in: query description: '' required: false example: id schema: type: string enum: - id - created_at x-apidog-enum: - value: id name: '' description: '' - value: created_at name: '' description: '' - name: sort_by in: query description: '' required: false example: DESC schema: type: string enum: - ASC - DESC x-apidog-enum: - value: ASC name: '' description: '' - value: DESC name: '' description: '' - name: Authorization in: header description: '' required: true example: '{{Autherization}}' schema: type: string - name: X-Manager-Token in: header description: '' required: false example: '{{Access-Token}}' schema: type: string - name: Accept in: header description: >- Specifies the Media Types acceptable for the client. In this case, it signals that the client expects a response in the JSON format. required: true example: application/json schema: type: string default: application/json - name: Accept-Language in: header description: '' required: false example: en schema: type: string enum: - ar - en x-apidog-enum: - value: ar name: '' description: '' - value: en name: '' description: '' responses: '200': description: '' content: application/json: schema: type: object properties: status: type: string pagination: type: object properties: page: type: integer next_page: type: integer last_page: type: integer result_count: type: integer required: - page - next_page - last_page - result_count x-apidog-orders: - page - next_page - last_page - result_count x-apidog-ignore-properties: [] reviews: type: array items: $ref: '#/components/schemas/ManagerProductReviewPresenter' message: &ref_0 $ref: '#/components/schemas/ResponseEnvelopMessage' required: - status - pagination - reviews - message x-apidog-orders: - status - pagination - reviews - message x-apidog-ignore-properties: [] examples: '1': summary: Success value: status: object pagination: page: 1 next_page: 2 last_page: 15 result_count: 45 reviews: - id: 0423eb5a-3aab-407c-9d00-624bc01970a0 customer: id: 8878912 name: Guest product: id: a626fd78-a373-428b-a264-cfcbf7378a13 name: The Third kit shirt, season 2022/2023 bought_this_item: false image: null status: approved is_anonymous: true rating: 0 comment: test edit_requested: false original_snapshot: null reply: null images: [] created_at: '2023-11-09 09:14:32' updated_at: '2025-06-23 23:06:57' - id: 08004cf2-8d35-4b12-8852-97dd6c4a27c9 customer: id: 179647 name: test store product: id: cc578c44-2bb4-45bc-969a-579c405fbab1 name: product with variance - Cowhide - أبيض - XL bought_this_item: true image: null status: approved is_anonymous: false rating: 3 comment: جميل جدا edit_requested: false original_snapshot: null reply: null images: [] created_at: '2022-08-28 12:48:21' updated_at: '2025-06-23 23:06:57' - id: 0881ad7f-219a-4cef-ab8a-7fd0d3d094f0 customer: id: 6626507 name: سلمان ياسر الغامدي product: id: a8ff4987-2b92-45f2-9927-9a905dd1ed04 name: yazeed test bought_this_item: false image: null status: approved is_anonymous: false rating: 5 comment: rating or smthn edit_requested: false original_snapshot: null reply: null images: [] created_at: '2023-07-12 13:57:42' updated_at: '2025-06-23 23:06:57' message: type: object code: null name: null description: null '2': summary: Success value: status: object pagination: page: 1 next_page: 2 last_page: 15 result_count: 45 reviews: - id: 0423eb5a-3aab-407c-9d00-624bc01970a0 customer: id: 8878912 name: Guest product: id: a626fd78-a373-428b-a264-cfcbf7378a13 name: The Third kit shirt, season 2022/2023 bought_this_item: false image: null status: approved is_anonymous: true rating: 0 comment: test edit_requested: false original_snapshot: null reply: null images: [] created_at: '2023-11-09 09:14:32' updated_at: '2025-06-23 23:06:57' - id: 08004cf2-8d35-4b12-8852-97dd6c4a27c9 customer: id: 179647 name: test store product: id: cc578c44-2bb4-45bc-969a-579c405fbab1 name: product with variance - Cowhide - أبيض - XL bought_this_item: true image: null status: approved is_anonymous: false rating: 3 comment: جميل جدا edit_requested: false original_snapshot: null reply: null images: [] created_at: '2022-08-28 12:48:21' updated_at: '2025-06-23 23:06:57' - id: 0881ad7f-219a-4cef-ab8a-7fd0d3d094f0 customer: id: 6626507 name: سلمان ياسر الغامدي product: id: a8ff4987-2b92-45f2-9927-9a905dd1ed04 name: yazeed test bought_this_item: false image: null status: approved is_anonymous: false rating: 5 comment: rating or smthn edit_requested: false original_snapshot: null reply: null images: [] created_at: '2023-07-12 13:57:42' updated_at: '2025-06-23 23:06:57' message: type: object code: null name: null description: null headers: {} x-apidog-name: OK '401': description: '' content: application/json: schema: type: object description: >- Response returned when the request cannot be authenticated because the required credentials are missing, invalid, or expired. properties: status: type: string description: Indicates the overall status of the API response. examples: - error message: type: object description: >- Contains structured details explaining why the request could not be authenticated. properties: type: type: string description: Indicates the category of the response message. examples: - error code: type: string description: >- A machine-readable code identifying the authentication error. Returns null when no specific code is available. examples: - UNAUTHORIZED nullable: true name: type: string description: >- A short, human-readable title describing the authentication error. Returns null when no title is available. examples: - Unauthorized nullable: true description: type: string description: >- A human-readable explanation of why the request could not be authenticated. Returns null when no detailed explanation is available. examples: - >- Authentication credentials are missing, invalid, or expired. nullable: true required: - type - code - name - description x-apidog-orders: - type - code - name - description x-apidog-ignore-properties: [] required: - status - message x-apidog-orders: - status - message examples: - status: error message: type: error code: UNAUTHORIZED name: Unauthorized description: >- Authentication credentials are missing, invalid, or expired. x-apidog-ignore-properties: [] examples: '3': summary: Example 1 value: status: error message: type: error code: ERROR_SESSION_MISSING name: Sorry description: Please login first. '4': summary: Example 2 value: status: error message: type: error code: ERROR_SESSION_INVALID name: Sorry description: Login session expired. Please login again. '5': summary: Example 3 value: status: error message: type: error code: ERROR_SESSION_INVALID name: Sorry description: Invalid authentication headers: {} x-apidog-name: Unauthorized '500': description: '' content: application/json: schema: type: object properties: status: type: string description: Status of the error. message: *ref_0 required: - status - message x-apidog-orders: - status - message x-apidog-ignore-properties: [] example: status: error message: type: error code: MSG_HIDDEN name: Error description: Internal Server Error headers: {} x-apidog-name: Internal Server error security: [] x-apidog-folder: Default module/Apps/Merchant APIs/Products/Product Reviews x-apidog-status: released x-run-in-apidog: https://app.apidog.com/web/project/613905/apis/api-10488550-run components: schemas: ResponseEnvelopMessage: type: object properties: type: type: string description: Type of response message returned by the API. examples: - success code: type: string description: Response code returned by the API, if available. examples: - MSG_POPUP_OK nullable: true name: type: string description: Name or title of the response message, if available. examples: - Coupons nullable: true description: type: string description: Detailed description of the response message, if available. examples: - Coupons created successfully nullable: true required: - type - code - name - description description: Additional response metadata. x-apidog-orders: - type - code - name - description x-apidog-ignore-properties: [] x-apidog-folder: '' ManagerProductReviewPresenter: type: object properties: id: type: string customer: type: object properties: id: type: integer name: type: string required: - id - name x-apidog-orders: - id - name x-apidog-ignore-properties: [] product: type: object properties: id: type: string name: type: string bought_this_item: type: boolean image: type: 'null' required: - id - name - bought_this_item - image x-apidog-orders: - id - name - bought_this_item - image x-apidog-ignore-properties: [] status: type: string is_anonymous: type: boolean rating: type: integer comment: type: string edit_requested: type: boolean original_snapshot: type: object properties: comment: type: string rating: type: string images: type: array items: type: string previous_status: type: string x-apidog-orders: - comment - rating - images - previous_status required: - comment - rating - images - previous_status x-apidog-ignore-properties: [] nullable: true reply: anyOf: - $ref: '#/components/schemas/ReviewReplyPresenter' - type: 'null' images: type: array items: &ref_1 $ref: '#/components/schemas/ReviewImagePresenter' created_at: type: string updated_at: type: string required: - id - customer - product - status - is_anonymous - rating - comment - edit_requested - original_snapshot - reply - images - created_at - updated_at x-apidog-orders: - id - customer - product - status - is_anonymous - rating - comment - edit_requested - original_snapshot - reply - images - created_at - updated_at x-apidog-ignore-properties: [] x-apidog-folder: '' ReviewImagePresenter: type: object properties: key: type: string path: type: string x-apidog-orders: - key - path required: - key - path x-apidog-ignore-properties: [] x-apidog-folder: '' ReviewReplyPresenter: type: object properties: id: type: string text: type: string nullable: true images: type: array items: *ref_1 created_at: type: string updated_at: type: string x-apidog-orders: - id - text - images - created_at - updated_at required: - id - text - images - created_at - updated_at x-apidog-ignore-properties: [] x-apidog-folder: '' securitySchemes: {} servers: - url: https://api.zid.sa/ description: Prod Env security: [] ```