Search API
1. API Search places, hotels by keyword
GET: api/v3/hotel/search-keyword
Search for places and hotels by keyword.
keyword query (String, optional) Search keyword
language query (String, Required)
Language
vi
: Vietnameseen
: English
pageNumber
query
(String, Optional)Page No
pageSize
quer
y (String, Optional)Number of elements on the page
Response
Code 200
Model
result(SearchKeywordResult, optional) Information returned results
contents (Array[Content], optional), List of areas, hotels
searchCode(String, optional), Search Identifier
searchType(string, optional) = [CONTINENT, COUNTRY, PROVINCE_STATE, HIGH_LEVEL_REGION, MULTI_CITY_VICINITY, CITY, NEIGHBORHOOD, AIRPORT, POINT_OF_INTEREST, TRAIN_STATION, METRO_STATION, HOTEL],
Search Type
name(String, optional), Name of area, hotel
supplier(String, optional) = [EXPEDIA, AXISROOM, BEDLINKER, VINPEARL], Supplier
address(Address, optional) Hotel address information
city(string, optional), City
countryCode(string, optional), Country code
countryName(string, optional), Country name
lineOne(string, optional), Address line 1
lineTwo(string, optional), Address line 2
postalCode(string, optional), ZIP code
stateProvinceCode(string, optional), City code
stateProvinceName(string, optional) Name of province
tags (Array[String], optional), Tags
duration (integer, optional),
errors (Array[Error], optional),
infos(Array[Info], optional),
success(boolean, optional),
textMessage(string, optional)
2. Hotel Search API with best price selection (search-best-rate)
GET: /api/v3/hotel/search-best-rates
Returns hotel search results with the best price selection.
The data will be cached for a period of time with the key as searchId. Caching time is about 15 minutes, this time is subject to change.
Allows filtering and sorting of returned results.
filterGeoDistanceLat
filterGeoDistanceLon
filterGeoDistanceMeters
Parameters
rateOption query(String, optional)
Price options. There are 2 pricing options:
OTA, TA
. Default isOTA
.Attention
Only TA contracting partners can use the TA pricing option.
If you want to get both price options, then
?rateOption=TA,OTA&...
searchCode
query
(String, Required)Area code or hotel code.
In case you want to search by hotel list, you must first get the hotel list containing the id to search.
Syntax to find multiple hotels
...&searchCode=id1,id2,id3&searchType=HOTEL&supplier=GOTADI&...
searchType
query
(String, Required)Area code type. Ex: CITY, HOTEL, …
language
query
(String, Required)Language. (vi, en)
currency
query
(String, Required)Currency. (VND, USD)
checkIn
query
(String, Required)Check-in date. Format: yyyy-MM-dd
checkOut
query
(String, Required)Check-out date. Format: yyyy-MM-dd
paxInfos
query
(String[], Required)Room and guest information
Format:
SoNguoiLon-TuoiTreEm1,TuoiTreEm2
For example:
2 adults and 2 children, 1 4-year-old, 1 6-year-old:
...&paxInfos=2-4,6&...
2 rooms, room 1 includes 2 adults, room 2 includes 2 adults and 2 children, 1 child 4 years old and 1 child 6 years old:
...&paxInfos=2&paxInfos=2-4,6&...
supplier
query
(String, Required)Supplier, Get information from the results returned item 4.2
filterHotelName
query
(String, Optional)Filter by names that start with
filterHotelCategories
query
(String, Optional)Filter by hotel category
filterFromPrice
query
(Double, Optional)Filter by price starting from
filterToPrice
query
(Double, Optional)Filter by price ending to
filterFromStarRating
query
(Double, Optional)Filter by star rating starting from
filterToStarRating
query
(Double, Optional)Filter by star rating ending to
filterFromGuestRating
query
(Double, Optional)Filter by guest reviews starting at
filterToGuestRating
query
(Double, Optional)Filter by guest reviews ending in
filterAmenities
query
(String[], Optional)Filter by hotel amenities
filterRoomAmenities
query
(String[], Optional)Filter by room amenities
filterRoomViews
query
(String[], Optional)Filter by room view
filterThemes
query
(String[], Optional)Filter by hotel theme
filterMealPlans
query
(String[], Optional)Filter by meal
filterGeoDistanceLat
query
(Double, Optional)Filter by lat . coordinates
filterGeoDistanceLon
query
(Double, Optional)Filter by coordinates lon
filterGeoDistanceMeters
query
(Integer, Optional)Filter by coordinates and distance. Units of meters
sortField
query
(String, Optional)Sort by: price, starRating, guestRating
sortOrder
query
(String, Optional)Sort by: ASC, DESC
pageNumber
query
(String, Optional)Page No
pageSize
query
(String, Optional)Number of elements on the page
Response
Code 200
OK
Model
result (Object, Optional)
Thông tin kết quả trả về
searchId (String, Optional)
Mã tham chiếu đến kết quả tìm kiếm
searchId được tạo ra dựa trên các tham số bắt buộc, nếu các tham số không thay đổi thì searchId sẽ không thay đổi
Được dùng làm tham số khi search-all-rates
propertyAvailable (Array[PropertyAvailable], Optional)
Mảng chứa đối tượng thông tin khách sạn
address (Address, optional),
Thông tin địa chỉ khách sạn
city (string, optional),
Thành phố
countryCode (string, optional),
Mã quốc gia
countryName (string, optional),
Tên quốc gia
lineOne (string, optional),
Địa chỉ dòng 1
lineTow (string, optional),
Địa chỉ dòng 2
postalCode (string, optional),
Mã bưu điện
stateProvinceCode (string, optional),
Mã tỉnh thành
stateProvinceName (string, optional)
Tên tỉnh thành
amenities (Array[Amenity], optional),
Thông tin danh sách tện nghi kèm theo của tùy chọn giá
id (string, optional),
Id của tiện nghi
name (string, optional)
Tên của tiện nghi
value (string, optional)group (string, optional)
basePrice (number, optional),
Giá cơ bản
basePriceBeforePromo (number, optional),
Giá cơ bản trước khuyến mãi. Nếu không có khuyến mãi thì giá trị là 0
breakfastIncluded (boolean, optional),
Có bao gồm bữa ăn sáng hay không
cancelFree (boolean, optional),
Cho phép hủy phòng miễn phí hay không
currency (string, optional) = [‘VND’, ‘USD’],
Tiền tệ
images (Array[HotelImage], optional),
Thông tin hình ảnh của khách sạn
caption (string, optional),
Tiêu đề hình ảnh
link (string, optional),
Liên kết hình ảnh, là đường dẫn tuyệt đối
position (integer, optional)
Vị trí sắp xếp của hình ảnh
language (string, optional) = [‘vi’, ‘en’],
Ngôn ngữ
latitude (number, optional),
Vĩ độ
longitude (number, optional),
Kinh độ
promo (boolean, optional),
Có khuyến mãi hay không
propertyCategory (PropertyCategory, optional),
Danh mục khách sạn
id (string, optional),
Id danh mục khách sạn
name (string, optional)
Tên danh mục khách sạn
propertyId (string, optional),
Id định danh khách sạn
propertyName (string, optional),
Tên khách sạn
refundable (boolean, optional),
Có được trả tiền khi hủy phòng hay không
reviewCount (string, optional),
Số lượng đánh giá của khách
reviewRecommendPercent (string, optional),reviewScore (string, optional),
Điểm đánh giá trung bình của khách. Lớn nhất là 5
stars (string, optional),
Hạng sao khách sạn
supplier (string, optional) = [‘EXPEDIA’, ‘AXISROOM’, ‘BEDLINKER’],
Nguồn cung cấp khách sạn
tags (Array[string], optional),
Thẻ cuả khách sạn
taxAndServiceFree (number, optional),
Thuế và phí kèm theo
totalPrice (number, optional),
Tổng giá tiền tạm tính
totalRooms (integer, optional),
Số lượng phòng còn trống có thể book
tripAdvisor (TripAdvisor, optional)rateOption (String, optional)
Tuỳ chọn giá. Có 2 tuỳ chọn giá là
OTA, TA
. Mặc định làOTA
.masterPropertyId (Long, optional)
Mã định danh khách sạn chính.
pageResult (Object, Optional)
Thông tin trang trả về
pageSize (Integer, Optional)
Kích thước trang
pageNumber (Integer, Optional)
Thứ tự trang
totalPage (Integer, Optional)
Tổng số trang
totalItems (Integer, Optional)
Tổng số phần tử
duration (Integer, Optional)
success (Integer, Bool)
infos (Array[InfosDTO], Optional)
errors (Array[ErrorsDTO], Optional)
textMessage (String, Optional)
3. API Filter option
GET: /api/v3/hotel/filter-options
Lấy danh sách các giá trị có thể áp dụng trên bộ lọc trên kết quả tìm kiếm. Có thể áp dụng cùng lúc nhiều bộ lọc với nhau.
Parameters
Response
Code 200
Model
result (FilterOptionsResult, optional)
Thông tin kết quả trả về
guestRatings (Array[FilterItemDouble], optional),
Thông tin đánh giá khách sạn của khách. Cao nhất là 5
name (string, optional),
Tên bộ lọc đánh giá của khách
value (number, optional)
Giá trị bộ lọc đánh gía của khách
language (string, optional) = [‘vi’, ‘en’],
Ngôn ngữ trả về
mealPlans (Array[FilterItemString], optional),
Thông tin tùy chọn bộ lọc theo bữa ăn
name (string, optional),
Mô tả bữa ăn
value (string, optional)
Id của bộ lọc bữa ăn
prices (Array[FilterPrice], optional),
Thông tin tùy chọn theo bộ lọc giá
operator (string, optional),
Phương thức so sánh
less_than
: Giá nhỏ hơnrange
: Giá trong khoảnggreater_than
: Giá lớn hơn
from (number, optional),
Giá từ
to (number, optional)
Giá đến
propertyAmenities (Array[FilterItemString], optional),
Thông tin bộ lọc theo tiện nghi khách sạn
name (string, optional),
Mô tả tiện nghi
value (string, optional)
Id của bộ lọc tiện nghi
propertyCategories (Array[FilterItemString], optional),
Thông tin bộ lọc theo danh mục khách sạn
name (string, optional),
Mô tả danh mục khách sạn
value (string, optional)
Id của bộ lọc theo danh mục khách sạn
propertyRatings (Array[FilterItemDouble], optional),
Thông tin bộ lọc theo hạng sao
name (string, optional),
Mô tả hạng sao
value (number, optional)
Giá trị hạng sao
roomAmenities (Array[FilterItemString], optional),
Thông tin bộ lọc theo tiện nghi trong phòng
name (string, optional),
Mô tả tiện nghi trong phòng
value (string, optional)
Id của bộ lọc theo tiện nghi trong phòng
roomViews (Array[FilterItemString], optional),
Thông tin bộ lọc theo hướng nhìn phòng
name (string, optional),
Mô tả hướng nhìn phòng
value (string, optional)
Id của bộ lọc theo hướng nhìn phòng
themes (Array[FilterItemString], optional)
Thông tin bộ lọc theo chủ đề của khách sạn
name (string, optional),
Mô tả chủ đề của khách sạn
value (string, optional)
Id của bộ lọc theo chủ đề
bedTypes (Array[FilterItemString], optional)
Thông tin bộ lọc theo loại giường của khách sạn
name (string, optional),
Mô tả loại giường của khách sạn
value (string, optional)
Id của bộ lọc theo loại giường
duration (integer, optional),
errors (Array[Error], optional),
infos (Array[Info], optional),
success (boolean, optional),
textMessage (string, optional)
4. Hotel Searching API with all prices rates (search-all-rates)
GET: /api/v3/hotel/search-all-rates
Kết quả trả về thông tin chi tiết của một khách sạn, thông tin phòng và thông tin của tất cả tùy chọn giá.
Mỗi một khách sạn có thể có 1 hoặc nhiều phòng, mỗi phòng sẽ có một hoặc nhiều tùy chọn giá khác nhau tùy theo bữa ăn và dịch vụ kèm theo.
Parameters
Parameters
searchId
query
(string, required)Mã tìm kiếm, được lấy từ mục search-all-rate
propertyId
query
(string, required)Mã định danh khách sạn theo supplier. Được lấy từ kết quả trả về của search-best-rate
supplier
query
(String, required)Nhà cung cấp. Được lấy từ kết quả trả về của search-best-rate
checkIn
query
(String, required)Ngày nhận phòng.
Định dạng:
yyyy-MM-dd
checkOut
query
(String, required)Ngày trả phòng.
Định dạng:
yyyy-MM-dd
paxInfos
query
(String[], required)Thông tin phòng và khách ở
Định dạng:
SoNguoiLon-TuoiTreEm1,TuoiTreEm2
Ví dụ:
2 người lớn và 2 trẻ em, 1 trẻ 4 tuổi, 1 trẻ 6 tuổi: `…&paxInfos=2-4,6&…
2 phòng, phòng 1 gồm 2 người lớn, phòng 2 gồm 2 người lớn và 2 trẻ em, 1 trẻ em 4 tuổi và 1 trẻ em 6 tuổi: `…&paxInfos=2&paxInfos=2-4,6&…
Response
Code 200
OK
Model
Model
result (SearchAllRatesResult, optional),
tripId (string, optional),
Mã định danh kết quả search-all-rate, mỗi lần gọi search-all-rate sẽ tạo ra tripId mới, nó được sử dụng khi đi thao tác đặt phòng
searchId (string, optional),
Mã tham chiếu đến search-best-rate, được lấy từ kết quả search-best-rate
propertyAllRate (PropertyAllRate, optional)
Thông tin trả về chi tiết của một khách sạn, thông tin phòng và thông tin của tất cả tùy chọn giá
address (Address, optional)
Thông tin địa chỉ khách sạn
city (string, optional),
Thành phố
countryCode (string, optional),
Mã quốc gia
countryName (string, optional),
Tên quốc gia
lineOne (string, optional),
Địa chỉ dòng 1
lineTow (string, optional),
Địa chỉ dòng 2
postalCode (string, optional),
Mã bưu điện
stateProvinceCode (string, optional),
Mã tỉnh thành
stateProvinceName (string, optional)
Tên tỉnh thành
airportCode (string, optional),
Mã sân bay
amenities (Array[Amenity], optional),
Mảng đối tượng chứa thông tin tiện nghi của khách sạn
id (string, optional),
Mã tiện nghi khách sạn
name (string, optional),
Tên của tiện nghi khách sạn
symbol (string, optional),
Biểu tượng hiển thị của tiện nghi khách sạn
value (string, optional)group (string, optional)
Thông tin tiện nghi của khách sạn được gom nhóm, với các nhóm sau
OTHER
: Tiện nghi khácPOPULAR_FACILITIES
: Tiện nghi phổ biếnSERVICE
: Dịch vụBUSINESS_SERVICE
: Dịch vụ doanh nghiệpRECREATION
: Cơ sở giải tríENTERTAINMENT
: Giải trí đa phương tiệnFITNESS_AND_SPA
: fitness và spaFOOD_AND_DRINK
: Khu vực ăn uốngCONVENIENCES
: Tiện íchINTERNET
: Mạng intenetPARKING_AND_TRANSPORT
: Khu vực để xe và đưa đónPET
: Thú cưng
attributes (Array[Attribute], optional),checkin (Checkin, optional),
Khoảng thời gian nhận phòng, theo giờ địa phương của khách sạn
beginTime (string, optional),
Thời gian bắt đầu được nhận phòng. Mặc định: 14:00
endTime (string, optional)
Thời gian kết thúc được nhận phòng. Mặc định: 24:00
checkout (Checkout, optional),
Thông tin thời gian trả phòng. Mặc định trước 12:00
endTime (string, optional)
Thời gian trả phòng tối đa. Mặc định trước 12:00
currency (string, optional) = [‘VND’, ‘USD’],
Thông tin tiền tệ trả về
descriptions (Array[Attribute], optional),
Thông tin mô tả về khách sạn
id (string, optional),
Mã định danh thuộc tính mô tả
name (string, optional),
Tên thuộc tính
description
: mô tả chungamenities
: mô tả chung về tiện nghi của khách sạndining
: Mô tả về chỗ ăn uống của khách sạnrenovations
: Mô tả về quá trình cải tạo phòng hoặc khách sạn mới đâynational_ratings
: Nêu rõ nguồn xếp hạng sao của khách sạnbusiness_amenities
: Mô tả về tiện nghi dành cho doanh nghiệp tại chỗ nghỉ, Ví dụ: phòng hội nghịrooms
: Mô tả về phòngattractions
: Mô tả về điểm tham quan gần khách sạnlocation
: Mô tả về vị trí của khách sạnheadline
: Mô tả tóm tắt
value (string, optional)
Thông tin mô tả
fees (Array[Attribute], optional),
Thông tin mô tả về một số khoản phụ phí kèm theo
id (string, optional),
Mã định danh thuộc tính phí
name (string, optional),
Tên thuộc tính phí
mandatory
: Phí bắt buộcoptional
: Phí không bắt buộc
value (string, optional)
Mô tả về khoản phí
images (Array[HotelImage], optional),
Hình ảnh của khách sạn
caption (string, optional),
Tiêu đề của hình ảnh
link (string, optional),
Liên kết tới hình ảnh. Liên kết tuyệt đối
position (integer, optional)
Vị trí sắp xếp hình ảnh
inclusions (Array[Attribute], optional),
Mảng đối tượng chứa thông tin mô tả về thuộc tính của khách sạn
id (string, optional),
Mã định danh thuộc tính
name (string, optional),
Mô tả thuộc tính
value (string, optional)
language (string, optional) = [‘vi’, ‘en’],
Ngôn ngữ trả về
latitude (number, optional),
Vĩ độ của khách sạn
longitude (number, optional),
Kinh độ của khách sạn
policies (Array[Attribute], optional),
Thông tin về chính sách khách sạn mà khách cần lưu ý.
id (string, optional),
Mã định danh chính sách
name (string, optional),
Tên thuộc chính sách
know_before_you_go
: Mô tả thông tin có thể hữu ích khi lập kế hoạch cho chuyến đi đến nơi này
value (string, optional)
Mô tả về chính sách
propertyCategory (PropertyCategory, optional),
Danh mục của khách sạn
id (string, optional),
Mã định danh danh mục khách sạn
name (string, optional)
Tên danh mục khách sạn
propertyId (string, optional),
Mã định danh khách sạn
propertyName (string, optional),
Tên khách sạn
rank (integer, optional),rating (Rating, optional),
Đánh giá về khách sạn
ratingGuest (RatingGuest, optional)
Đánh giá của khách
amenities (string, optional),
Xếp hạng cho các tiện nghi do khách sạn cung cấp, được tính trung bình từ tất cả các đánh giá của khách. Trả về giá trị từ 1,0 đến 5,0.
cleanliness (string, optional),
Đánh giá mức độ sạch sẽ cho khách sạn, được tính trung bình từ tất cả các đánh giá của khách. Trả về giá trị từ 1,0 đến 5,0.
comfort (string, optional),
Đánh giá mức độ thoải mái của các phòng, được tính trung bình từ tất cả các đánh giá của khách. Trả về giá trị từ 1,0 đến 5,0.
condition (string, optional),
Xếp hạng cho tình trạng của chỗ nghỉ, được tính trung bình từ tất cả các đánh giá của khách. Trả về giá trị từ 1,0 đến 5,0.
count (integer, optional),
Tất cả xếp hạng đánh giá của khách giành cho khách sạn
location (string, optional),
Xếp hạng về mức độ hấp dẫn của vị trí của khách sạn, được tính trung bình từ tất cả các đánh giá của khách. Trả về giá trị từ 1,0 đến 5,0.
neighborhood (string, optional),
Xếp hạng về mức độ hài lòng của khu vực lân cận của khách sạn, được tính trung bình từ tất cả các đánh giá của khách. Trả về giá trị từ 1,0 đến 5,0.
overall (string, optional),
Đánh giá chung cho khách sạn, được tính trung bình từ tất cả các đánh giá của khách. Trả về giá trị từ 1,0 đến 5,0.
quality (string, optional),
Xếp hạng chất lượng của các phòng, được tính trung bình từ tất cả các đánh giá của khách. Trả về giá trị từ 1,0 đến 5,0.
recommendationPercent (string, optional),
Phần trăm khách giới thiệu ở tại chỗ nghỉ này.
score (string, optional),service (string, optional),
Đánh giá về dịch vụ của nhân viên đối với chỗ nghỉ, được tính trung bình từ tất cả các đánh giá của khách. Trả về giá trị từ 1,0 đến 5,0.
value (string, optional)
Xếp hạng cho giá trị của bất động sản cung cấp cho chi phí lưu trú, được tính trung bình từ tất cả các đánh giá của khách. Trả về giá trị từ 1,0 đến 5,0.
ratingProperty (RatingProperty, optional)
Đánh giá hạng sao khách sạn
rating (string, optional),
Giá trị sếp hạng. Trả về giá trị từ 0,0 đến 5,0. Giá trị 0,0 hoặc giá trị trống cho biết không có xếp hạng nào.
type (string, optional)
Loại đánh giá
Star
: Xếp hạng sao của khách sạn
rooms (Array[PropertyRoom], optional),
Mảng đối tượng chứa thông tin phòng
descriptions (Array[Attribute], optional),
Thông tin mô tả
id (string, optional),
Mã định danh
name (string, optional),
Tên mô tả
overview
: Thông tin mô tả tổng quan về căn phòng
value (string, optional)
Thông tin mô tả
id (string, optional),
Mã định danh cho loại phòng
images (Array[RoomImage], optional),
Mảng đối tượng chứa thông tin hình ảnh của loại phòng
caption (string, optional),
Tiêu đề của hình ảnh
link (string, optional),
Liên kết tới hình ảnh, là liên kết tuyệt đối
position (integer, optional)
Vị trí sắp xếp của hình ảnh
name (string, optional),
Tên của loại phòng
ratePlans (Array[RatePlan], optional),
Mảng đối tượng chứa thông tin về tùy chọn giá
amenities (Array[Amenity], optional),
Mảng đối tượng chứa thông tin tiện nghi của tùy chọn giá
id (string, optional),
Mã định danh tiện nghi
name (string, optional),
Tên tiện nghi
value (string, optional)group (sting, optional)
basePrice (number, optional),
Giá cơ bản
basePriceBeforePromo (number, optional),
Giá cơ bản trước khuyến mãi
bedGroups (Array[BedGroup], optional),
Mảng đối tượng nhóm giường trong phòng
configurations (Array[ConfigurationBedGroup], optional),
Thông tin cấu hình giường cho phòng
quantity (integer, optional),
Số lượng giường
size (string, optional),
Kích thước của giường
type (string, optional)
Loại giường
description (string, optional),
Mô tả hiển thị giường cho phòng này
id (string, optional)
Mã định danh nhóm giường
breakfastIncluded (boolean, optional),
Tùy chọn giá có bao gồm bữa sáng hay không
cancelFree (boolean, optional),
Mô tả thông tin được phép hủy đặt phòng với tùy chọn giá này có tốn phí phạt hay không
true
: Hủy đặt phòng miễn phífalse
: Không đặt hủy đặt phòng miễn phí
cancelFreeBeforeDate (string, optional),
Ngày giới hạn cho phép hủy đặt phòng với tùy chọn giá này một cách miễn phí
cancelPenalties (Array[CancelPenalty], optional),
Mô tả các hình thức phạt khi hủy đặt phòng với tùy chọn giá này. Xem mô tả thêm ở đây
type (string, optional)
Loại hình phạt
NIGHTS
: Số đêm bị phạtAMOUNT
: Số tiền bị phạtPERCENT
: Số phần trăm bị phạt
currency (string, optional) = [‘VND’, ‘USD’],
Đơn vị tiền tệ đối với
type = AMOUNT
amount (string, optional),
Số tiền của hình phạt
description (string, optional),
Mô tả về hình phạt
nights (string, optional),
Số đêm bị tính phí phạt
percent (string, optional),
Số phần trăm bị phạt
startDate (string, optional),
Ngày bắt đầu có hiệu lực của hình phạt
endDate (string, optional),
Ngày kết thúc của hình phạt
fees (Map, optional),
Thông tin các loại phí được phu bởi khách sạn Giá trị mối loại phí là tổng của loại đó. Phạm vi ảnh hưởng của mô tả này chỉ là thông tin thông báo cho khách hàng biết.
mandatory_fee
: Một khoản phí bắt buộc do khách sạn thu khi nhận phòng hoặc trả phòng.resort_fee
: Một khoản phí cho các tiện nghi và dịch vụ bổ sung và được khách sạn thu khi nhận phòng hoặc trả phòng.mandatory_tax
: Khoản thuế bắt buộc do chỗ nghỉ thu khi nhận phòng hoặc trả phòng.
paxPrice (Array[PaxPrice], optional),
Mảng đối tượng chứa thông tin giá theo số lượng người ở trong một phòng
nightPrices (Array[NightPrice], optional),
Mảng đối tượng chứa thông tin giá theo từng đêm
nightKey (string, optional),
Khóa định danh của từng đêm
nightPriceDetails (Array[NightPriceDetail], optional)
Mảng đối tượng chứ thông tin giá chi tiết theo từng đêm
name (string, optional),
Tên loại giá
base_rate
: Giá cơ bản không bao gồm thuế phítax_and_service_fee
: Thuế và phí
value (number, optional),
Số tiền
valueByHotelCurrency (string, optional)
paxInfo (PaxInfo, optional)
Mô tả thông tin người ở
adultQuantity (integer, optional),
Số lượng người lớn
childAges (Array[integer], optional),
Mảng chứa thông tin tuổi của trẻ em, số lượng phần từ mảng bằng với số lượng trẻ em
childQuantity (integer, optional),
Số lượng trẻ em
infantQuantity (integer, optional)
promo (boolean, optional),
Thông tin xác định có khuyến mãi hay không
true
: Có khuyến mãifalse
: Không có khuyến mãi
promoDescription (string, optional),
Mô tả thông tin khuyến mãi
ratePlanId (string, optional),
Mã định danh tùy chọn giá
ratePlanName (string, optional),
Tên của tùy chọn giá
refundable (boolean, optional),
Thông tin xác định khi hủy phòng có được hoàn tiền hay không
true
: Được hoàn tiền khi hủyfalse
: Không được hoàn tiền khi hủy
taxAndFees (number, optional),
Thuế và phí của tùy chọn giá
totalPrice (number, optional),
Giá tổng cộng đã bao gồm thuế phí
totalPriceByHotelCurrency (number, optional),totalRooms (integer, optional)
Số lượng phòng còn trống
roomArea (RoomArea, optional)
Thông tin về diện tích căn phòng
squareFeet
: Diện tích của phòng được tính bằng feet vuôngsquareMeters
: Diện tích của phòng được tính bằng mét vuông
bedGroupStatics (Array[BedGroupStatic], optional)
Mảng các đối tượng nhóm giường trong phòng
id (String, optional)
mã định danh nhóm giường
name (String, optional)
Tên nhóm giường
value (String, optional)
views (Array[View], optional)
Thông tin mô tả hướng nhìn của phòng
id (String, optional)
mã định danh hướng nhìn
name (String, optional)
Mô tả hướng nhìn
value (String, optional)
occupancyAllowed (OccupancyAllowed, optional)
Thông tin về số người ở được phép
roomMaxAllowed (RoomMaxAllowed, optional)
Sức chứa tối đa
adult (integer, optional)
Số người lớn
children (integer, optional)
Số trẻ em
total (integer, optional)
Tổng số người
roomAgeCategories (Array[Attribute], optional)
amenities (Array[Amenity], optional)
Mảng chứa đối tương thông tin tiện nghi của phòng
id (string, optional),
Mã định danh tiện nghi phòng
name (string, optional),
Tên tiện nghi phòng
symbol (string, optional),
Biểu tượng hiện thị của nghi phòng
value (string, optional)group (string, optional)
Thông tin tiện nghi của phòng được gom nhóm, với các nhóm sau
OTHER
: Tiện nghi khácBEDROOM
: Tiện nghi phòng ngủBATHROOM
: Tiện nghi phòng tắmENTERTAINMENT
: Giải trí đa phương tiện trong phòngFOOD_AND_DRINK
: Tiện nghi về đồ ăn thức uống trong phòngROOM_VIEW
: Hướng nhìnINTERNET
: Mạng intenetSMOKING
: Hút thuốc
spokenLanguage (Array[Attribute], optional),
Các ngôn ngữ giao tiếp với nhân viên khách sạn.
id (string, optional),
Mã định danh ngôn ngữ
name (string, optional),
Tên ngôn ngữ
value (string, optional)
statistics (Array[Attribute], optional),
Thống kê về tài sản, chẳng hạn như số tầng
id (string, optional),
Mã định danh thống kê
name (string, optional),
Mô tả thống kê bao gồm tên và giá trị thống kê
{ "id": "52", "name": "Tổng số phòng: - 335", "value": "335" }
value (string, optional)
Giá trị của thống kê
supplier (string, optional) = [EXPEDIA, AXISROOM, BEDLINKER],
Nguồn khách sạn
tags (Array[string], optional),
Thẻ được gắn cho khách sạn, để xác định một số yêu cầu đặc biệt
themes (Array[Attribute], optional)
Mảng đối tượng chứa thông tin về chủ đề của khách sạn
id (string, optional),
Mã định chủ đề
name (string, optional),
Tên chủ đề
value (string, optional)
masterPropertyId (Long, optional)
Mã định danh khách sạn chính.
duration (integer, optional),
errors (Array[Error], optional),
infos (Array[Info], optional),
success (boolean, optional),
textMessage (string, optional)
5. API Get all hotel list
GET: /api/v3/hotel/get-master-properties
Get list of all basic hotel information
Example
Find by update time
?language=vi&lastModifiedDate=2021-09-10&pageNumber=0&pageSize=50
Find by Id
?id=123&language=vi
Parameters
Response
Code 200
Model
Model
result (FilterOptionsResult, optional)
Thông tin kết quả trả về
masterProperties (Array[MasterProperty], optional),
Danh sách thông tin khách sạn
id (Long, optional),
Mã định danh
propertyName (string, optional),
Tên khách sạn
address (Address, optional)
Thông tin địa chỉ khách sạn
city (string, optional),
Thành phố
countryCode (string, optional),
Mã quốc gia
countryName (string, optional),
Tên quốc gia
lineOne (string, optional),
Địa chỉ dòng 1
lineTow (string, optional),
Địa chỉ dòng 2
postalCode (string, optional),
Mã bưu điện
stateProvinceCode (string, optional),
Mã tỉnh thành
stateProvinceName (string, optional)
Tên tỉnh thành
propertyLocation (PropertyLocation, optional) = [‘vi’, ‘en’],
Vị trí toạ độ
longitude (string, optional),
Kinh độ
latitude (string, optional),
Vĩ độ
activated (boolean, required),
Trạng thái
true
: hoạt động /false
: không hoạt độnglegacyIds (Array[Long], optional),
Danh sách mã định danh cũ
duration (integer, optional),
errors (Array[Error], optional),
infos (Array[Info], optional),
success (boolean, optional),
textMessage (string, optional)
Last updated