Review API

circle-check

Review is the way to share your stay experience with others, and it can be used not only by future travelers but also by competing hotels to see what others are saying about them so that they may improve their services.

People are more likely to book a room in a hotel that has a large number of reviews. They always keen to get an idea of what the experience will be like before actually booking it.

For hoteliers, positive reviews and the customer satisfaction are most important factors because they can encourage the business.

  • Su Review API allows delivery of guest reviews to property.

  • Reviews only shared for guests with booking.

  • API applicable for supported channel(s).


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. 19, for Booking.com).


channel_property_id string

Specifies the channel-specific hotel ID


channel_review_id string

Specifies the channel-specific review for the property.


channel_booking_id string

Specifies the unique booking identifier assigned by the channel.


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 that contains the rating categories and corresponding scores provided by the guest. The categories included depend on the data received from the channel.

circle-info

Possible values range: 0 to 10 (type : float)


review_type string

Specifies the type of review.


review_status string

Indicates the status of the review.

circle-info

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


review_date string

The date when the review was created.

circle-info

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


Response

Sample Success Response


Response Body Element

Status string

Indicates the result of the API call.

circle-info

Will be "Success" for successful operations.

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


Review Reply

Partners can reply to guest reviews on the supported channel, i.e., Booking.com.


Endpoint

POST


Attributes

hotel_id alphanumeric (Required)

Specifies the hotel ID for the property.


channel_id alphanumeric (Required)

Identifier of the distribution channel (OTA).


channel_property_id alphanumeric (Required)

Specifies the channel-specific hotel ID.


channel_review_id string (Required)

Specifies the channel-specific review ID


review_reply string (Required)

Specifies the reply from the partner for the review.


Sample Request


Response

Sample Success Response


Sample Error Response

Response Body Element

Status string

Indicates the result of the API call.

circle-info

Will be "Success" for successful operations.

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


Data object

The response data, the root element.


Message string

The message in the response.


Code string

Specific error code that helps identify the type of error.


ShortText string

A short description of the error.

Indicates channel room id and rate id.


Status string

Indicates the result of the API call.

circle-info

Will be "Success" for successful operations.

Last updated

Was this helpful?