v1

latestOpenAPI 3.0.32026-08-06150495.9 KB

Reviews API

Reply To Review

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

POST

URL

{{base-url}}/v1/partnerApi/review-manager/reply

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.
ddReviewType	string	Indicates doordash review type (e.g., STAR_RATING, THREE_BUTTON_RATING). This is only available for doordash reviews else it will be null.
ddReviewValue	string	Indicates doordash review value (e.g., LOVED, THUMBS_UP, FIVE, THREE). This is only available for doordash reviews else it will be null.

Example Request Body

{
  "promoValue": 0,
  "comment": "Hello Jessica, We appreciate ...",
  "deliveryUUID": "5d594684-e433-3001-bece-56a015 ...",
  "customerId": "",
  "feedback": "",
  "listingId": "P1351",
  "rating": 5,
  "channel": "DOORDASH",
  "customerName": "Jessica W",
  "reviewCreated": "2025-04-12",
  "ddReviewType": "THREE_BUTTON_RATING",
  "ddReviewValue": "LOVED"
}

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

{
    "status": true,
    "statusCode": 200,
    "message": "Review respond request initiated",
    "result": {
        "message": "review respond request initiated"},
    "error": null
}

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.

post/v1/partnerApi/review-manager/reply

Headers

tokenstring

Example:{{access-token}}

user-agentstring

Example:Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/135.0.0.0 Safari/537.36

Request body

channelstring

commentstring

customerIdstring

customerNamestring

deliveryUUIDstring

feedbackstring

listingIdstring

promoValuenumber

ratingnumber

reviewCreatedstring

ddReviewTypestring

ddReviewValuestring

Example request

{
  "channel": "DOORDASH",
  "comment": "Hello Jessica,  We appreciate your 5-star rating! Thank you for choosing us through DoorDash!",
  "customerName": "Jessica W",
  "deliveryUUID": "5d594684-e433-0152e47b0",
  "listingId": "P1351",
  "rating": 5,
  "reviewCreated": "2025-04-12",
  "ddReviewType": "THREE_BUTTON_RATING",
  "ddReviewValue": "LOVED"
}

Response

200

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

messagestring

statusboolean

statusCodenumber

Example response

{
  "message": "Review respond request initiated",
  "result": {
    "message": "review respond request initiated"
  },
  "status": true,
  "statusCode": 200
}