Search API

1. API Tìm kiếm địa điểm, khách sạn theo từ khoá

GET: api/v3/hotel/search-keyword

Tìm kiếm địa điểm, khách sạn theo từ khoá.

Parameters

keyword query (String, optional)
Từ khoá tìm kiếm
language query (String, Required)
Ngôn ngữ
- vi : Tiếng Việt
- en: Tiếng Anh
pageNumber query (String, Optional)
Trang số
pageSize query (String, Optional)
Số phần tử trên trang

Example

Response

Code 200

Model

result (SearchKeywordResult, optional)
Thông tin kết quả trả về
- contents (Array[Content], optional),
  Danh sách khu vực, khách sạn
  - searchCode (String, optional),
    Mã định danh tìm kiếm
  - searchType (string, optional) = [CONTINENT, COUNTRY, PROVINCE_STATE, HIGH_LEVEL_REGION, MULTI_CITY_VICINITY, CITY, NEIGHBORHOOD, AIRPORT, POINT_OF_INTEREST, TRAIN_STATION, METRO_STATION, HOTEL],
    Loại tìm kiếm
  - name (String, optional),
    Tên khu vực, khách sạn
  - supplier (String, optional) = [EXPEDIA, AXISROOM, BEDLINKER, VINPEARL],
    Nhà cung cấp
  - 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
  - tags (Array[String], optional),
    Thẻ
duration (integer, optional),
errors (Array[Error], optional),
infos (Array[Info], optional),
success (boolean, optional),
textMessage (string, optional)

2. API Tìm kiếm khách sạn với lựa chọn giá tốt nhất (search-best-rate)

GET: /api/v3/hotel/search-best-rates

Trả về kết quả tìm kiếm khách sạn với lựa chọn giá tốt nhất.

Dữ liệu sẽ được caching trong một khoảng thời gian theo với key là searchId. Thời gian caching khoảng 15 phút, thời gian này có thể bị thay đổi.

Cho phép lọc và sắp xếp kết quả trả về.

Chú ý

Lọc theo tọa độ, khoảng cách yêu cầu 3 tham số:

filterGeoDistanceLat
filterGeoDistanceLon
filterGeoDistanceMeters

Parameters

rateOption query (String, optional)
Tuỳ chọn giá. Có 2 tuỳ chọn giá là OTA, TA. Mặc định là OTA.
Chú ý
- Chỉ nhưng đối tác ký hợp đồng TA mới được sử dụng tuỳ chọn giá TA.
- Muốn lấy cả 2 option giá thì ?rateOption=TA,OTA&...
searchCode query (String, Required)
Mã khu vực hoặc mã khách sạn.
- Search khu vực : mã khu vực
- Search khác sạn : 1 hoặc nhiều mã khách sạn tương ứng với supplier
  - Trường hợp mong muốn tìm kiếm theo danh sách khách sạn cụ thể, trước tiên phải lấy danh sách khách sạn có chứa id để tìm kiếm.
  - Trường hợp sử dụng mã khách sạn tương ứng với supplier GOTADI thì hệ thống sẽ tự động chọn giá khách sạn theo tiêu chí ưu tiên
    Cú pháp tìm nhiều khách sạn ...&searchCode=id1,id2,id3&searchType=HOTEL&supplier=GOTADI&...
searchType query (String, Required)
Kiểu mã khu vực. Vd: CITY, HOTEL, …
language query (String, Required)
Ngôn ngữ. (vi, en)
currency query (String, Required)
Tiền tệ. (VND, USD)
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&...
supplier query (String, Required)
- Nhà cung cấp, Lấy thông tin từ kết quả trả về mục 4.2
- Mỗi bộ search code sẽ tương ứng riêng với từng nhà cung cấp khác nhau
- Xem quy tắc nhà cung cấp
targertSupplier query (String, Optional)
- Khi có giá trị này hệ thống sẽ bỏ qua các quy trình chọn nhà cung cấp tự động theo tiêu chí
locationCoordinates query (String, Optional)
- Require khi không có searchCode và searchType
- Toạ độ trung tâm địa điểm, tìm kiếm theo bán kính mặc định
- Cú pháp : &locationCoordinates=10.7568,10.5689
radius query (Double, Optional) Bán kính tìm kiếm tuỳ chọn (km)
filterHotelName query (String, Optional)
Lọc theo tên bắt đầu bằng
filterHotelCategories query (String, Optional)
Lọc theo danh mục khách sạn
filterFromPrice query (Double, Optional)
Lọc theo giá bắt đầu từ
filterToPrice query (Double, Optional)
Lọc theo giá kết thúc đến
filterFromStarRating query (Double, Optional)
Lọc theo hạng sao bắt đầu từ
filterToStarRating query (Double, Optional)
Lọc theo hạng sao kết thúc đến
filterFromGuestRating query (Double, Optional)
Lọc theo đánh giá của khách bắt đầu từ
filterToGuestRating query (Double, Optional)
Lọc theo đánh giá của khách kết thúc đến
filterAmenities query (String[], Optional)
Lọc theo tiên nghi khách sạn
filterRoomAmenities query (String[], Optional)
Lọc theo tiện nghi phòng
filterRoomViews query (String[], Optional)
Lọc theo hướng nhìn của phòng
filterThemes query (String[], Optional)
Lọc theo chủ đề của khách sạn
filterMealPlans query (String[], Optional)
Lọc theo bữa ăn
filterGeoDistanceLat query (Double, Optional)
Lọc theo tọa độ lat
filterGeoDistanceLon query (Double, Optional)
Lọc theo tọa độ lon
filterGeoDistanceMeters query (Integer, Optional)
Lọc theo tọa độ và khoảng cách. Đơn vị mét
filterBreakfastIncluded query (Boolean, Optional) Lọc theo bao gồm bữa ăn sáng
filterCancelFree query (Boolean, Optional) Lọc theo bao gồm huỷ miễn phí
sortField query (String, Optional)
Sắp xếp theo: price, starRating, guestRating
sortOrder query (String, Optional)
Sắp xếp theo thứ tự: ASC, DESC
pageNumber query (String, Optional)
Trang số
pageSize query (String, Optional)
Số phần tử trên trang

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, require) = [‘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.
  - distanceToCenter (String, optional) Khoảng cách từ khách sạn đến điểm trung tâm nếu search bằng toạ độ
  - availableType (String, require) Loại kết quả search
    ON_REQUEST : liên hệ để đặt SOLD_OUT: vừa hết phòng AVAILABLE : khách sạn còn phòng RECOMMENDED : khách sạn đề xuất
- shortLinkId (String, require) id thay thế một số param cho API search-all-rate
- 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)

Example

3. API Tùy chọn bộ lọc

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

language query (String, Required)
Ngôn ngữ
- vi : Tiếng Việt
- en: Tiếng Anh

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ơn
    range: Giá trong khoảng
    greater_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. API Tìm kiếm khách sạn với tất cả tùy chọn giá (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

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&…
shortLinkId query (String, Optional)
- Giá trị thay thế cho các param: searchId, checkIn, checkout, paxInfos
masterPropertyId query( String, Optional)
- id khách sạn ưng với supplier GOTADI
- Require nếu sử dụng shorlinkId

Response

Code 200

OK

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ác
    POPULAR_FACILITIES: Tiện nghi phổ biến
    SERVICE: Dịch vụ
    BUSINESS_SERVICE: Dịch vụ doanh nghiệp
    RECREATION: Cơ sở giải trí
    ENTERTAINMENT: Giải trí đa phương tiện
    FITNESS_AND_SPA: fitness và spa
    FOOD_AND_DRINK: Khu vực ăn uống
    CONVENIENCES: Tiện ích
    INTERNET: Mạng intenet
    PARKING_AND_TRANSPORT: Khu vực để xe và đưa đón
    PET: 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ả chung
    amenities: mô tả chung về tiện nghi của khách sạn
    dining: Mô tả về chỗ ăn uống của khách sạn
    renovations: Mô tả về quá trình cải tạo phòng hoặc khách sạn mới đây
    national_ratings: Nêu rõ nguồn xếp hạng sao của khách sạn
    business_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òng
    attractions: Mô tả về điểm tham quan gần khách sạn
    location: Mô tả về vị trí của khách sạn
    headline: 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ộc
    optional: 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ạt
    AMOUNT: Số tiền bị phạt
    PERCENT: 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ãi
    false: 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ủy
    false: 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ông
    squareMeters: 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ác
    BEDROOM: Tiện nghi phòng ngủ
    BATHROOM: Tiện nghi phòng tắm
    ENTERTAINMENT: Giải trí đa phương tiện trong phòng
    FOOD_AND_DRINK: Tiện nghi về đồ ăn thức uống trong phòng
    ROOM_VIEW: Hướng nhìn
    INTERNET: Mạng intenet
    SMOKING: 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 Lấy danh sách khách sạn

GET: /api/v3/hotel/get-master-properties

Lấy danh sách thông tin cơ bản của khách sạn.

Parameters

id query (String, optional)
Mã định danh khách sạn
language query (String, Required)
Ngôn ngữ
- vi : Tiếng Việt
- en: Tiếng Anh
lastModifiedDate query (String, optional)
Ngày cập nhật
pageNumber query (String, Optional)
Trang số
pageSize query (String, Optional)
Số phần tử trên trang

Example

Response

Code 200

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 động
  - legacyIds (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)

PreviousHotel NextBooking API

Last updated 3 months ago