Reviews

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).

---

Collection of Reviews from OTA

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.

Only one endpoint is required to support both Reviews API and Messaging API. Meaning, both Reviews and Messages are posted to the same endpoint.

Endpoint

END POINT: Please provide endpoint for reviews delivery.

Authorization String: Partner to allocate with Basic Authorization credentials.

---

Attributes

message string (Optional)

This is message in the review.

---

guestid string (Optional)c

The unique guest ID as assigned by the provider (OTA) upon creation.

ID can be both numeric, alphanumeric and may have special character such as hyphen ( - ).

---

bookingid string (Optional)

Booking ID of the Booking.

ID can be both numeric, alphanumeric and may have special character such as hyphen ( - ). For Airbnb, if communication started before booking is made, the parameter will be the thread ID.

---

listingid string (Optional)

Property ID of the hotel (Channel Hotel ID).

---

bookingflag string (Optional)

The flag of the booking.

Values can be either B or T (B = Booking, T = Thread). Please note if there is no booking ID, the value will the same for both booking and thread ID.

---

messageid string (Optional)

This is message id for the particular message.

---

channel_id string (Optional)

Generated while delivering reviews from OTA.

Airbnb Channel ID: 244

---

threadid string (Optional)

The thread id created when communication takes place between guest and client,

ID can be both numeric, alphanumeric and may have special character such as hyphen ( - ).

---

User details

User_details contains the information about the user such as roles and name of users.

---

roles array (Optional)

These are the different roles.

---

users array (Optional)

These are the name of users.

---

attachment array (Optional)

These are the attachments with the review if any.

---

Review object

Review received from OTA.

Attributes

---

action string (Optional)

Action on the review, for example review_published.

---

reviewid string (Optional)

Id of the review.

---

reviewerid string (Optional)

Unique identity of the reviewer.

---

reviewer_role string (Optional)

Role of the reviewer.

---

revieweeid string (Optional)

Unique identity of the reviewee.

---

reviewee_role string (Optional)

Role of the reviewee.

---

listing_id string (Optional)

Unique identity of the listing.

---

private_feedback string (Optional)

Private feedback if any.

---

public_review string (Optional)

Public review if any.

---

hidden string (Optional)

If the review is hidden or shown.

---

submitted string (Optional)

If the review is submitted or in other state.

---

submitted_at string (Optional)

Time and date when the review is submitted.

---

expires_at string (Optional)

Time and date when the review gets expired.

---

booking_id string (Optional)

Booking id for which the review is posted.

---

ratings string (Optional)

Rating given by the reviewer.

---

hotelcode string (Optional)

It is the Hotel ID or Property ID assigned in Su.

Su Property ID.

Sample Request

{
	"message": "",
	"guestid": "229895150",
	"bookingid": "HM2ABCQQFK",
	"listingid": "26789052",
	"bookingflag": "RG",
	"messageid": "419122356925038040162840360849",
	"channel_id": "244",
	"threadid": "419122356925038040",
	"user_details": {
		"roles": [],
		"users": []
	},
	"booking_details": {},
	"attachment": [],
	"review": {
		"action": "review_published",
		"reviewid": 419122356988838000,
		"reviewerid": 54970082,
		"reviewer_role": "host",
		"revieweeid": 229665005,
		"reviewee_role": "guest",
		"listing_id": "26789052",
		"private_feedback": "TQVM boleh datang lagi ya ð",
		"public_review": "Great guest!.",
		"hidden": false,
		"submitted": true,
		"submitted_at": "2021-08-07T05:06:49.279Z",
		"expires_at": "2021-08-15T06:41:18.403Z",
		"booking_id": "HM2ABCQQFK",
		"ratings": []
	},
	"hotelcode": "abc123"
}

---

Response

If acknowledgement is not received as required, system will try to repost the review 3 times. After 3 attempts, review will be removed from queue.

Sample Success Response

{
 "status": "Success"
}

---

Review Response API

• API allows respond to guests' reviews to property.

• Reviews only shared for guests with booking can be responded.

• API applicable for supported channel(s).

---

Response to Reviews Collection from OTA

Once reviews received from OTA, will be delivered to partner by post method. Reviews made from guest to host can be responded using API.

Only reviews received / initiated from guest can be responded.

Endpoint

POST

https://connect-sandbox.su-api.com/SUAPI/jservice/OTA_ReplyReview

---

Attributes

---

hotelid string (Optional)

It is the Hotel ID or Property ID assigned in Su.

Su Property ID.

---

channelid string (Optional)

Generated while delivering reviews from OTA.

Airbnb Channel ID: 244

---

replytext string (Optional)

The response to the review.

---

listingid string (Optional)

Property ID of the hotel (Channel Hotel ID).

---

locationid string (Optional)

Account / Host ID of the channel (Airbnb).

---

reviewid string (Optional)

ID of the review allocated which is being responded.

Sample Request

{
    "hotelid": "new1",
    "channelid": "244",
    "replytext": "Hello, Thank you for your review. We will get back to you with more details.",
    "listingid": "38740008",
    "locationid": "111201086",
    "reviewid": "11001"
}

---

Response

Sample Success Response

{
 "status": "Success"
}