Retrieve Review

The reviews received from OTA are delivered to partner by post method. Reviews are posted to an endpoint provided by partner. Please note reviews can only be delivered to a single dedicated endpoint. Upon receipt, partners will need to filter reviews based on property ID.

---

Endpoint

Please provide endpoint for reviews delivery. 

Authorization String: Partner has to provide Authorization credentials.

---

Attributes

hotel_id alphanumeric

Specifies the hotel ID for the property.

---

channel_id string

The identifier of the connected channel (e.g., Agoda, Booking.com).

---

channel_property_id string

Specifies the channel-specific hotel ID

---

channel_review_id string

Specifies the channel-specific review for the property.

---

review_title string

Specifies the title of review for the property.

---

review_description string

Specifies the description for the review.

---

review_negative_description string

Specifies the negative description for the review.

---

review_score object

An object containing the rating scores given by the guest.

---

cleanliness integer

Rating for cleanliness (scale typically 1–5).

---

location integer

Rating for location (scale typically 1–5).

---

overall integer

Overall rating score (scale can vary, e.g., 1–100).

---

review_type string

Specifies the type of review.

---

review_status string

Indicates the status of the review.

Possible values: "published", "created", "in_review".

---

review_date string

The date when the review was created. Format: YYYY-MM-DD.

---

is_eligible_to_respond boolean

Indicates whether the host is allowed to respond to the review.

---

reviewee_name string

The name of the host being reviewed.

---

Sample Request

{
  "hotel_id": "AWSTEST",
  "channel_id": "19",
  "channel_property_id": "123456",
  "channel_review_id": "19_HJDHDH",
  "review_title": "Great stay!",
  "review_description": "Loved the location and service.",
  "review_negative_description": "Room was a bit small.",
  "review_score": {
    "cleanliness": 5,
    "location": 5,
    "overall": 55
  },
  "review_type": "guest_to_host",
  "review_status": "published / created / in_review",
  "review_date": "2025-01-01",
  "is_eligible_to_respond": true,
  "reviewee_name": "Vishal Potter"
}

---

Response

Sample Success Response

Sample Success Response

{
"status": "Success"
}

---

Response Body Element

Status string

Indicates the result of the API call.

Will be "Success" for successful operations.

Will be always "Fail" in case of an error response.