Get Hotel List API

Description: Retrieve all of the available hotel(s) for a given set of search criteria. Breakdown hotels into many smaller get hotel list requests

Path: /api/v2/hotel/getHotelList

Method: POST

Content Type/Accept Type: application/json

Request

Attributes

* = required

clientId*

string

Identity of client

timestamp*

timestamp

Current timestamp

hotelSnList

array<integer>

List of Go2Joy hotel SN can contain up to 50 hotel SNs at maximum. All Get Hotel List requests can be sent in parallel

criteria*

criteria.bookingType*

integer

Type of booking

Possible enum values: 1 = Hourly Booking 2 = Overnight Booking 3 = Daily Booking

criteria.checkInDatePlan*

string

Check-in date (user plan)

Format: YYYY-mm-dd

criteria.endDate*

string

Check-out date (user plan)

Format: YYYY-mm-dd

criteria.startTime

string

Required when choosing Hourly Booking

Format: HH:mm

criteria.endTime

string

Required when choosing Hourly Booking

Format: HH:mm

criteria.provinceSn

integer

Identity of province

criteria.districtSn

integer

Identity of district

criteria.promotion

integer

Type of promotion

Possible enum values: 0 = All (default) 1 = FlashSale 2 = Direct discount

criteria.bedTypeList

array<integer>

List room’s bed type

Possible enum values: 1 = Single 2 = Double 3 = Twin 4 = Triple 5 = 2 Double

criteria.facilityList

array<integer>

List room’s facility

criteria.viewList

array<integer>

List room’s view

Possible enum values: 1 = Window 2 = Balcony 3 = City 4 = Garden 5 = Pool 6 = None

criteria.maxPrice

integer

Max room’s price. Filter based on the best hotel's room rate.

Maximum recommended value is 20.000.000 (VND)

criteria.minPrice

integer

Min room’s price. Filter based on the best hotel's room rate.

limit

integer

Number of item per page (default: 10, max: 50)

page

integer

Page number (default: 1)

sortType

integer

Sort's Type

Possible enum values: 0 = None (default) 1 = Price increasing 2 = Price decreasing 3 = Hotel’s Rating 4 = Hotel’s Review

Example

{
    "clientId": "04x1236-f424-4728-8oba-3652fc5059e1",
    "timestamp": 1689583111,
    "criteria": {
        "bookingType": 2,
        "checkInDatePlan": "2023-08-31",
        "endDate": "2023-09-01"
    },
    "hotelSnList": [110],
    "limit": 10
}

Response

Attributes

sn

integer

Identity of hotel

name

string

Hotel's name

soldOut

boolean

Rooms of all rate plans are sold out

ratePlanList.ratePlan

ratePlanList.ratePlan.numOfRoom

integer

Num of room left. If the value returns as 2147483647 (max int value), the actual value could not be determined.

ratePlanList.ratePlan.originalPrice

integer

Original price

ratePlanList.ratePlan.currentPrice

integer

Current price

ratePlanList.ratePlan.flashSale

boolean

On/off label flash sale

ratePlanList.ratePlan.directDiscount

boolean

On/off label direct discount

ratePlanList.ratePlan.highDemand

boolean

On/off label high demand

Example

{
    "code": 1,
    "message": "All went well, and (usually) some data was returned.",
    "error": null,
    "data": {
        "hotelList": [
            {
                "sn": 110,
                "name": "VĨNH PHÚ GIA HOTEL",
                "soldOut": false,
                "ratePlanList": [
                    {
                        "numOfRoom": 1,
                        "originalPrice": 500000,
                        "currentPrice": 100000,
                        "flashSale": true,
                        "directDiscount": false,
                        "highDemand": true
                    },
                    {
                        "numOfRoom": 1,
                        "originalPrice": 500000,
                        "currentPrice": 650000,
                        "flashSale": false,
                        "directDiscount": false,
                        "highDemand": true
                    },
                    {
                        "numOfRoom": 2147483647,
                        "originalPrice": 350000,
                        "currentPrice": 300000,
                        "flashSale": false,
                        "directDiscount": true,
                        "highDemand": false
                    }
                ]
            }
        ],
        "meta": {
            "total": 1,
            "perPage": 10,
            "currentPage": 1,
            "lastPage": 1,
            "from": 1,
            "to": 1
        }
    },
    "timestamp": 1693467890
}