# Reviews API The **Reviews API** enables partners to access, manage, and respond to customer reviews for common clients across multiple platforms. This API provides: - **Reviews Data** – Retrieve detailed reviews submitted by customers across integrated platforms, including ratings, comments, and timestamps. - **Manual Reply to Reviews** – Submit replies manually to individual customer reviews directly through the API. This API helps partners streamline customer engagement, maintain brand reputation, and ensure timely responses to feedback across platforms. ## Get All Order Reviews - [POST /v1/partnerApi/review-manager/reviews](https://api.voosh.ai/main/reviews-api/getallorderreviews.md): # Review Manager API - Fetch Reviews This endpoint allows you to retrieve reviews associated with specific listings within a defined date range. You can specify the number of reviews to return, as well as pagination options. ## Request ### HTTP Method ### URL ### Request Body The request body must be in JSON format and includes the following parameters: | Key | Type | Description | | --- | --- | --- | | startDate | string | The start date for filtering reviews (format: YYYY-MM-DD). | | endDate | string | The end date for filtering reviews (format: YYYY-MM-DD). | | listingIds | array | An array of listing IDs to filter the reviews. | | channel | array | An array specifying the channels from which to fetch reviews (e.g., DOORDASH). | #### Example Request Body ## Response ### Response Body The response will be in JSON format and contains the following structure: | Key | Type | Description | | --- | --- | --- | | status | boolean | Indicates the success of the request. | | statusCode | integer | A code representing the status of the request (0 for success). | | message | string | A message providing additional information about the request. | | result | object | Contains the main data returned from the API. | | error | object | Contains error details if the request was unsuccessful. | #### Result Structure The object may contain the following keys: | Key | Type | Description | | --- | --- | --- | | total | integer | The total number of reviews matching the criteria. | | reviews | array | An array of review objects. | | totalUnAnswered | integer | The total number of unanswered reviews. | | unAnsweredReviews | array | An array of unanswered review objects. | | totalYelp | integer | The total number of Yelp reviews. | | yelpReviews | array | An array of Yelp review objects. | | unansweredYelp | integer | The total number of unanswered Yelp reviews. | | unansweredReviewsYelp | array | An array of unanswered Yelp review objects. | #### Reviews Array Structure Each object in the array contains the following fields: | Key | Type | Description | | --- | --- | --- | | uuid | string | Unique identifier for the review. | | date | string | The date the review was created. | | daysLeftToReply | integer | The number of days left to respond to the review. | | orderSubTotal | number | The subtotal of the order associated with the review. | | CustomerId | string | Unique identifier for the customer who left the review. | | storeId | string | Unique identifier for the store associated with the review. | | brandId | string | Unique identifier for the brand associated with the review. | | deliveryUUID | string | Unique identifier for the order associated with the review. | | toBeReviewed | boolean | Indicates if the review is pending for a response. | | reviewId | string | Unique identifier for the review. | | CustomerName | string | Name of the customer who left the review. | | ListingId | string | Unique identifier for the listing associated with the review. | | channel | string | The channel from which the review originated. | | orderRating | integer | Rating given by the customer for the order. | | reviewReplyPromoValue | number | Promotional value associated with the review reply, if any. | | orderFeedback | string | Feedback provided by the customer regarding the order. | | reviewReplyComment | string | Comment provided in response to the review, if any. | | orderDate | string | The date the order was placed. | | reviewCreated | string | The timestamp when the review was created. | | reviewReplyCreated | string | The timestamp when the review reply was created, if applicable. | | reviewReplied | boolean | Indicates if a reply has been made to the review. | | yelpReplyApproved | boolean | Indicates if the Yelp reply has been approved. | | customerType | string | Type of the customer (e.g., new, returning). | | autoReply | boolean | Indicates if the reply was generated automatically. | #### Example Response ### Status Codes - : The request was successful, and the response contains the requested data. - : Refer to the API documentation for additional status codes and their meanings. This endpoint is essential for managing and analyzing reviews across different channels, helping businesses to respond effectively to customer feedback. ## Reply To Review - [POST /v1/partnerApi/review-manager/reply](https://api.voosh.ai/main/reviews-api/replytoreview.md): ## Review Reply API This endpoint allows partners to submit replies to reviews for their listings. It is designed to facilitate communication with customers by enabling businesses to respond to feedback directly. ## Request ### HTTP Method ### URL ### Request Parameters The request body must be sent in JSON format and includes the following parameters: | Field | Type | Description | | --- | --- | --- | | promoValue | integer | A value representing any promotional offer associated with the reply. | | comment | string | The text of the reply to the customer's review. | | deliveryUUID | string | A unique identifier for the delivery associated with the review. | | customerId | string | The unique identifier of the customer who left the review. | | feedback | string | Any additional feedback that may be relevant. | | listingId | string | The unique identifier of the listing being reviewed. | | rating | integer | The rating given by the customer (scale typically from 1 to 5). | | channel | string | The platform through which the review was received (e.g., DOORDASH). | | customerName | string | The name of the customer who left the review. | | reviewCreated | string | The date when the review was created. | ### Example Request Body ### Expected Response Upon a successful request, the API will return a response with the following structure: | Field | Type | Description | | --- | --- | --- | | status | boolean | Indicates whether the request was successful. | | statusCode | integer | A code representing the status of the response. | | message | string | A message providing additional information about the response. | | result | object | Contains further details about the result of the operation. | | result.message | string | Any relevant message related to the result. | | error | null or object | Will be null if there is no error; otherwise, it will contain error details. | ### Example Response Body ### Notes - A successful request will typically return a 200 status code. - The response structure is consistent across various endpoints of this API, allowing ease of integration and understanding. - Ensure that all required fields are populated correctly to avoid errors in submission.