v1

latestOpenAPI 3.0.32026-08-06150495.9 KB
Reviews API

Get All Order Reviews

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

POST

URL

{{base-url}}/v1/partnerApi/review-manager/reviews?limit=3&offset=1&order=-1

Request Body

The request body must be in JSON format and includes the following parameters:

KeyTypeDescription
startDatestringThe start date for filtering reviews (format: YYYY-MM-DD).
endDatestringThe end date for filtering reviews (format: YYYY-MM-DD).
listingIdsarrayAn array of listing IDs to filter the reviews.
channelarrayAn array specifying the channels from which to fetch reviews (e.g., DOORDASH).

Example Request Body

{
    "startDate": "2025-06-06",
    "endDate": "2025-07-06",
    "listingIds": [
        "P67071",
        "P67073"
    ],
    "channel": [
        "DOORDASH",
        "UBEREATS",
        "GRUBHUB"
    ]}

Response

Response Body

The response will be in JSON format and contains the following structure:

KeyTypeDescription
statusbooleanIndicates the success of the request.
statusCodeintegerA code representing the status of the request (0 for success).
messagestringA message providing additional information about the request.
resultobjectContains the main data returned from the API.
errorobjectContains error details if the request was unsuccessful.

Result Structure

The result object may contain the following keys:

KeyTypeDescription
totalintegerThe total number of reviews matching the criteria.
reviewsarrayAn array of review objects.
totalUnAnsweredintegerThe total number of unanswered reviews.
unAnsweredReviewsarrayAn array of unanswered review objects.
totalYelpintegerThe total number of Yelp reviews.
yelpReviewsarrayAn array of Yelp review objects.
unansweredYelpintegerThe total number of unanswered Yelp reviews.
unansweredReviewsYelparrayAn array of unanswered Yelp review objects.

Reviews Array Structure

Each object in the reviews array contains the following fields:

KeyTypeDescription
uuidstringUnique identifier for the review.
datestringThe date the review was created.
daysLeftToReplyintegerThe number of days left to respond to the review.
orderSubTotalnumberThe subtotal of the order associated with the review.
CustomerIdstringUnique identifier for the customer who left the review.
storeIdstringUnique identifier for the store associated with the review.
brandIdstringUnique identifier for the brand associated with the review.
deliveryUUIDstringUnique identifier for the order associated with the review.
toBeReviewedbooleanIndicates if the review is pending for a response.
reviewIdstringUnique identifier for the review.
CustomerNamestringName of the customer who left the review.
ListingIdstringUnique identifier for the listing associated with the review.
channelstringThe channel from which the review originated.
orderRatingintegerRating given by the customer for the order.
reviewReplyPromoValuenumberPromotional value associated with the review reply, if any.
orderFeedbackstringFeedback provided by the customer regarding the order.
reviewReplyCommentstringComment provided in response to the review, if any.
orderDatestringThe date the order was placed.
reviewCreatedstringThe timestamp when the review was created.
reviewReplyCreatedstringThe timestamp when the review reply was created, if applicable.
reviewRepliedbooleanIndicates if a reply has been made to the review.
yelpReplyApprovedbooleanIndicates if the Yelp reply has been approved.
customerTypestringType of the customer (e.g., new, returning).
autoReplybooleanIndicates if the reply was generated automatically.
ddReviewTypestringIndicates doordash review type (e.g., STAR_RATING, THREE_BUTTON_RATING). This is only available for doordash reviews else it will be null.
ddReviewValuestringIndicates doordash review value (e.g., LOVED, THUMBS_UP, FIVE, THREE). This is only available for doordash reviews else it will be null.

Example Response

{
  "status": true,
  "statusCode": 200,
  "message": "Reviews fetched successfully",
  "result": {
    "total": 33,
    "reviews": [
      {
        "uuid": "cfcd296b-214b-3001-923f-9a406df4424b",
        "date": "2025-07-05T01:08:44.000Z",
        "daysLeftToReply": 3,
        "orderSubTotal": 15.49,
        "CustomerId": "524823061",
        "storeId": "P6707",
        "brandId": "393",
        "deliveryUUID": "cfcd296b-214b-3001-923f-9a406df4424b",
        "toBeReviewed": null,
        "reviewId": null,
        "CustomerName": "Camilo T",
        "ListingId": "P67071",
        "channel": "DOORDASH",
        "orderRating": 5,
        "reviewReplyPromoValue": null,
        "orderFeedback": "",
        "reviewReplyComment": null,
        "orderDate": null,
        "reviewCreated": "2025-07-05T01:08:44.000Z",
        "reviewReplyCreated": null,
        "reviewReplied": false,
        "yelpReplyApproved": false,
        "customerType": "new",
        "autoReply": false
        "ddReviewType": "STAR_RATING",
        "ddReviewValue": "FIVE"
      }
    ],
    "totalUnAnswered": 5,
    "unAnsweredReviews": [
      {
        "uuid": "cfcd296b-214b-3001-923f-9a406df4424b",
        "date": "2025-07-05T01:08:44.000Z",
        "daysLeftToReply": 3,
        "orderSubTotal": 15.49,
        "CustomerId": "524823061",
        "storeId": "P6707",
        "brandId": "393",
        "deliveryUUID": "cfcd296b-214b-3001-923f-9a406df4424b",
        "toBeReviewed": null,
        "reviewId": null,
        "CustomerName": "Camilo T",
        "ListingId": "P67071",
        "channel": "DOORDASH",
        "orderRating": 5,
        "reviewReplyPromoValue": null,
        "orderFeedback": "",
        "reviewReplyComment": null,
        "orderDate": null,
        "reviewCreated": "2025-07-05T01:08:44.000Z",
        "reviewReplyCreated": null,
        "reviewReplied": false,
        "yelpReplyApproved": false,
        "customerType": "new",
        "autoReply": false,
        "ddReviewType": "THREE_BUTTON_RATING",
        "ddReviewValue": "LOVED"
      }
    ],
    "totalYelp": 0,
    "yelpReviews": [],
    "unansweredYelp": 0,
    "unansweredReviewsYelp": []
  },
  "error": null
}

Status Codes

  • 200 OK: The request was successful, and the response contains the requested data.

  • Other Status Codes: 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.

post/v1/partnerApi/review-manager/reviews

Query parameters

limitstring
Example:3
offsetstring
Example:1
orderstring
Example:-1

Headers

tokenstring
Example:{{access-token}}

Request body

channelstring[]
endDatestring
listingIdsstring[]
startDatestring

Example request

{
  "channel": [
    "DOORDASH",
    "UBEREATS",
    "GRUBHUB"
  ],
  "endDate": "2025-07-06",
  "listingIds": [
    "P67071",
    "P67073"
  ],
  "startDate": "2025-06-06"
}

Response

200

{"stackTrail":"paths:/v1/partnerApi/review-manager/reviews:post:responses:200:content:application/json:schema:properties:error","oasType":"schema","type":"unknown","example":null,"nullable":true}
messagestring
statusboolean
statusCodenumber

Example response

{
  "message": "Reviews fetched successfully",
  "result": {
    "reviews": [
      {
        "CustomerId": "524823061",
        "CustomerName": "Camilo T",
        "ListingId": "P67071",
        "autoReply": false,
        "brandId": "393",
        "channel": "DOORDASH",
        "customerType": "new",
        "date": "2025-07-05T01:08:44.000Z",
        "daysLeftToReply": 3,
        "deliveryUUID": "cfcd296b-214b-3001-923f-9a406df4424b",
        "orderDate": null,
        "orderFeedback": "",
        "orderRating": 5,
        "orderSubTotal": 15.49,
        "reviewCreated": "2025-07-05T01:08:44.000Z",
        "reviewId": null,
        "reviewReplied": false,
        "reviewReplyComment": null,
        "reviewReplyCreated": null,
        "reviewReplyPromoValue": null,
        "storeId": "P6707",
        "toBeReviewed": null,
        "uuid": "cfcd296b-214b-3001-923f-9a406df4424b",
        "yelpReplyApproved": false,
        "ddReviewType": "STAR_RATING",
        "ddReviewValue": "FIVE"
      },
      {
        "CustomerId": "419738068",
        "CustomerName": "Thiago P",
        "ListingId": "P67071",
        "autoReply": false,
        "brandId": "393",
        "channel": "DOORDASH",
        "customerType": "new",
        "date": "2025-07-04T00:20:47.000Z",
        "daysLeftToReply": 2,
        "deliveryUUID": "f9837863-06eb-3001-84d6-a9b0cc972465",
        "orderDate": null,
        "orderFeedback": "",
        "orderRating": 5,
        "orderSubTotal": 15.49,
        "reviewCreated": "2025-07-04T00:20:47.000Z",
        "reviewId": null,
        "reviewReplied": false,
        "reviewReplyComment": null,
        "reviewReplyCreated": null,
        "reviewReplyPromoValue": null,
        "storeId": "P6707",
        "toBeReviewed": null,
        "uuid": "f9837863-06eb-3001-84d6-a9b0cc972465",
        "yelpReplyApproved": false,
        "ddReviewType": "THREE_BUTTON_RATING",
        "ddReviewValue": "LOVED"
      },
      {
        "CustomerId": "806789871",
        "CustomerName": "Saman N",
        "ListingId": "P67071",
        "autoReply": false,
        "brandId": "393",
        "channel": "DOORDASH",
        "customerType": "new",
        "date": "2025-07-03T12:24:00.000Z",
        "daysLeftToReply": 2,
        "deliveryUUID": "00278e5e-9c5c-3001-b6ac-e4e169dd4428",
        "orderDate": null,
        "orderFeedback": "",
        "orderRating": 5,
        "orderSubTotal": 23.96,
        "reviewCreated": "2025-07-03T12:24:00.000Z",
        "reviewId": null,
        "reviewReplied": false,
        "reviewReplyComment": null,
        "reviewReplyCreated": null,
        "reviewReplyPromoValue": null,
        "storeId": "P6707",
        "toBeReviewed": null,
        "uuid": "00278e5e-9c5c-3001-b6ac-e4e169dd4428",
        "yelpReplyApproved": false,
        "ddReviewType": "THREE_BUTTON_RATING",
        "ddReviewValue": "LOVED"
      }
    ],
    "total": 33,
    "totalUnAnswered": 5,
    "unAnsweredReviews": [
      {
        "CustomerId": "524823061",
        "CustomerName": "Camilo T",
        "ListingId": "P67071",
        "autoReply": false,
        "brandId": "393",
        "channel": "DOORDASH",
        "customerType": "new",
        "date": "2025-07-05T01:08:44.000Z",
        "daysLeftToReply": 3,
        "deliveryUUID": "cfcd296b-214b-3001-923f-9a406df4424b",
        "orderDate": null,
        "orderFeedback": "",
        "orderRating": 5,
        "orderSubTotal": 15.49,
        "reviewCreated": "2025-07-05T01:08:44.000Z",
        "reviewId": null,
        "reviewReplied": false,
        "reviewReplyComment": null,
        "reviewReplyCreated": null,
        "reviewReplyPromoValue": null,
        "storeId": "P6707",
        "toBeReviewed": null,
        "uuid": "cfcd296b-214b-3001-923f-9a406df4424b",
        "yelpReplyApproved": false,
        "ddReviewType": "STAR_RATING",
        "ddReviewValue": "FIVE"
      },
      {
        "CustomerId": "419738068",
        "CustomerName": "Thiago P",
        "ListingId": "P67071",
        "autoReply": false,
        "brandId": "393",
        "channel": "DOORDASH",
        "customerType": "new",
        "date": "2025-07-04T00:20:47.000Z",
        "daysLeftToReply": 2,
        "deliveryUUID": "f9837863-06eb-3001-84d6-a9b0cc972465",
        "orderDate": null,
        "orderFeedback": "",
        "orderRating": 5,
        "orderSubTotal": 15.49,
        "reviewCreated": "2025-07-04T00:20:47.000Z",
        "reviewId": null,
        "reviewReplied": false,
        "reviewReplyComment": null,
        "reviewReplyCreated": null,
        "reviewReplyPromoValue": null,
        "storeId": "P6707",
        "toBeReviewed": null,
        "uuid": "f9837863-06eb-3001-84d6-a9b0cc972465",
        "yelpReplyApproved": false,
        "ddReviewType": "THREE_BUTTON_RATING",
        "ddReviewValue": "LOVED"
      },
      {
        "CustomerId": "806789871",
        "CustomerName": "Saman N",
        "ListingId": "P67071",
        "autoReply": false,
        "brandId": "393",
        "channel": "DOORDASH",
        "customerType": "new",
        "date": "2025-07-03T12:24:00.000Z",
        "daysLeftToReply": 2,
        "deliveryUUID": "00278e5e-9c5c-3001-b6ac-e4e169dd4428",
        "orderDate": null,
        "orderFeedback": "",
        "orderRating": 5,
        "orderSubTotal": 23.96,
        "reviewCreated": "2025-07-03T12:24:00.000Z",
        "reviewId": null,
        "reviewReplied": false,
        "reviewReplyComment": null,
        "reviewReplyCreated": null,
        "reviewReplyPromoValue": null,
        "storeId": "P6707",
        "toBeReviewed": null,
        "uuid": "00278e5e-9c5c-3001-b6ac-e4e169dd4428",
        "yelpReplyApproved": false,
        "ddReviewType": "THREE_BUTTON_RATING",
        "ddReviewValue": "LOVED"
      },
      {
        "CustomerId": "1087121981",
        "CustomerName": "A A",
        "ListingId": "P67071",
        "autoReply": false,
        "brandId": "393",
        "channel": "DOORDASH",
        "customerType": "new",
        "date": "2025-07-03T00:03:28.000Z",
        "daysLeftToReply": 1,
        "deliveryUUID": "8ffecad7-6ad3-3001-9ab7-f86cae7a9d00",
        "orderDate": null,
        "orderFeedback": "",
        "orderRating": 4,
        "orderSubTotal": 20.08,
        "reviewCreated": "2025-07-03T00:03:28.000Z",
        "reviewId": null,
        "reviewReplied": false,
        "reviewReplyComment": null,
        "reviewReplyCreated": null,
        "reviewReplyPromoValue": null,
        "storeId": "P6707",
        "toBeReviewed": null,
        "uuid": "8ffecad7-6ad3-3001-9ab7-f86cae7a9d00",
        "yelpReplyApproved": false,
        "ddReviewType": "THREE_BUTTON_RATING",
        "ddReviewValue": "THUMBS_UP"
      },
      {
        "CustomerId": "1235397984",
        "CustomerName": "Charlie S",
        "ListingId": "P67071",
        "autoReply": false,
        "brandId": "393",
        "channel": "DOORDASH",
        "customerType": "new",
        "date": "2025-07-02T02:33:45.000Z",
        "daysLeftToReply": 1,
        "deliveryUUID": "26402d02-1565-3001-878f-914a772ce678",
        "orderDate": null,
        "orderFeedback": "",
        "orderRating": 4,
        "orderSubTotal": 22.96,
        "reviewCreated": "2025-07-02T02:33:45.000Z",
        "reviewId": null,
        "reviewReplied": false,
        "reviewReplyComment": null,
        "reviewReplyCreated": null,
        "reviewReplyPromoValue": null,
        "storeId": "P6707",
        "toBeReviewed": null,
        "uuid": "26402d02-1565-3001-878f-914a772ce678",
        "yelpReplyApproved": false,
        "ddReviewType": "THREE_BUTTON_RATING",
        "ddReviewValue": "THUMBS_UP"
      }
    ],
    "unansweredReviewsYelp": [],
    "yelpReviews": []
  },
  "status": true,
  "statusCode": 200
}