apidocs
  1. Resource
apidocs
  • Auth
    • Ticket
      POST
  • Resource
    • CheckAvail
      POST
    • HotelDetail
      POST
    • HotelIdList
      POST
    • HotelList
      POST
  • Content
    • Region
      POST
    • Regions
      POST
  • Trade
    • Book
      POST
    • Cancel
      POST
    • QueryOrders
      POST
  1. Resource

HotelList

POST
/api/search/hotelList
Get hotel list by criteria. Room offers could be provided if asked.

Request

Header Params

Body Params application/json

Example
{
    "Authorization": "string",
    "Currency": "string",
    "Device-Id": "string",
    "IPv4": "string",
    "IPv6": "string",
    "Language": "string",
    "Session-Id": "string",
    "Test": "string",
    "Timeout-Milliseconds": 0,
    "Trace-Id": "string",
    "UseOriginal-Currency": true,
    "User-Agent": "string",
    "adultCount": 0,
    "checkIn": 0,
    "checkOut": 0,
    "childrenCount": 0,
    "countryCode": "string",
    "distance": {
        "point": {
            "gaode": {
                "lat": 0,
                "lng": 0
            },
            "google": {
                "lat": 0,
                "lng": 0
            }
        },
        "radius": 0
    },
    "guests": [
        {
            "age": 0,
            "mobilePhone": "string",
            "name": "string",
            "nationalityCode": "string",
            "roomIndex": 0
        }
    ],
    "hotelIds": [
        0
    ],
    "nationalityCode": "string",
    "pageNum": 0,
    "pageSize": 0,
    "price": {
        "highPrice": 0,
        "lowPrice": 0
    },
    "regionCode": 0,
    "regionName": "string",
    "requireRooms": true,
    "residencyCode": "string",
    "roomCount": 0,
    "roomTypeIds": "string"
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.hotelbyte.online/api/search/hotelList' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "Authorization": "string",
    "Currency": "string",
    "Device-Id": "string",
    "IPv4": "string",
    "IPv6": "string",
    "Language": "string",
    "Session-Id": "string",
    "Test": "string",
    "Timeout-Milliseconds": 0,
    "Trace-Id": "string",
    "UseOriginal-Currency": true,
    "User-Agent": "string",
    "adultCount": 0,
    "checkIn": 0,
    "checkOut": 0,
    "childrenCount": 0,
    "countryCode": "string",
    "distance": {
        "point": {
            "gaode": {
                "lat": 0,
                "lng": 0
            },
            "google": {
                "lat": 0,
                "lng": 0
            }
        },
        "radius": 0
    },
    "guests": [
        {
            "age": 0,
            "mobilePhone": "string",
            "name": "string",
            "nationalityCode": "string",
            "roomIndex": 0
        }
    ],
    "hotelIds": [
        0
    ],
    "nationalityCode": "string",
    "pageNum": 0,
    "pageSize": 0,
    "price": {
        "highPrice": 0,
        "lowPrice": 0
    },
    "regionCode": 0,
    "regionName": "string",
    "requireRooms": true,
    "residencyCode": "string",
    "roomCount": 0,
    "roomTypeIds": "string"
}'

Responses

🟢200OK
application/json
Success
Headers

Body

Example
{
    "basic": {
        "region": {
            "ancestors": [
                {
                    "ancestors": [
                        {}
                    ],
                    "coordinates": {
                        "boundingPolygon": {
                            "coordinates": [
                                {
                                    "lat": 0,
                                    "lng": 0
                                }
                            ],
                            "type": "string"
                        },
                        "centerLat": 0,
                        "centerLng": 0
                    },
                    "countryCode": "string",
                    "countrySubdivisionCode": "string",
                    "descendants": {},
                    "expediaId": "string",
                    "extra": {
                        "countryName": "string",
                        "nameZh": "string",
                        "provinceName": "string"
                    },
                    "id": 0,
                    "name": "string",
                    "nameFull": "string",
                    "tripId": "string",
                    "type": "0"
                }
            ],
            "coordinates": {
                "boundingPolygon": {
                    "coordinates": [
                        {
                            "lat": 0,
                            "lng": 0
                        }
                    ],
                    "type": "string"
                },
                "centerLat": 0,
                "centerLng": 0
            },
            "countryCode": "string",
            "countrySubdivisionCode": "string",
            "descendants": {},
            "expediaId": "string",
            "extra": {
                "countryName": "string",
                "nameZh": "string",
                "provinceName": "string"
            },
            "id": 0,
            "name": "string",
            "nameFull": "string",
            "tripId": "string",
            "type": "0"
        }
    },
    "hasMore": true,
    "list": [
        {
            "address": {
                "en": "string",
                "zh": "string"
            },
            "hotelSupplierRef": [
                {
                    "supplier": "0",
                    "supplierHotelId": "string"
                }
            ],
            "id": 0,
            "latlngCoordinator": {
                "gaode": {
                    "lat": 0,
                    "lng": 0
                },
                "google": {
                    "lat": 0,
                    "lng": 0
                }
            },
            "loyaltyProgram": {
                "brandId": 0,
                "brandName": "string",
                "groupId": 0,
                "groupName": "string"
            },
            "masterSupplier": "0",
            "minPrice": {
                "amount": 0,
                "currency": "string"
            },
            "name": {
                "en": "string",
                "zh": "string"
            },
            "pairDistance": {
                "straightLineDistance": 0
            },
            "rating": 0,
            "regionId": 0,
            "rooms": [
                {
                    "rates": [
                        {
                            "amenities": [
                                {}
                            ],
                            "available": true,
                            "bedTypes": [
                                {
                                    "desc": "string",
                                    "id": 0
                                }
                            ],
                            "cancelPolicy": {
                                "policies": [
                                    {
                                        "cancelFee": {
                                            "amount": 0,
                                            "currency": "string"
                                        },
                                        "deductionTimeWindow": {
                                            "end": "string",
                                            "start": "string"
                                        },
                                        "type": "",
                                        "typeName": "string"
                                    }
                                ],
                                "refundable": true,
                                "refundableMode": "fullyRefundable"
                            },
                            "dailyRates": [
                                {
                                    "date": 0,
                                    "rate": {
                                        "grossRate": {
                                            "amount": 0,
                                            "currency": "string"
                                        },
                                        "netRate": {
                                            "amount": 0,
                                            "currency": "string"
                                        },
                                        "respectGrossRate": true
                                    }
                                }
                            ],
                            "extendStay": {
                                "max": 0,
                                "min": 0
                            },
                            "inventory": 0,
                            "meal": {},
                            "occupancy": {
                                "adultsCount": 0,
                                "childAges": [
                                    0
                                ]
                            },
                            "payment": [
                                {}
                            ],
                            "rate": {
                                "grossRate": {
                                    "amount": 0,
                                    "currency": "string"
                                },
                                "netRate": {
                                    "amount": 0,
                                    "currency": "string"
                                },
                                "respectGrossRate": true
                            },
                            "ratePkgId": "string",
                            "ratePlanId": "string",
                            "tax": {
                                "total": {
                                    "amount": 0,
                                    "currency": "string"
                                }
                            },
                            "timestamp": 0
                        }
                    ],
                    "roomName": {
                        "en": "string",
                        "zh": "string"
                    },
                    "roomTypeId": "string"
                }
            ],
            "star": 0
        }
    ],
    "total": 0
}
🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🔴500Server Error
Modified at 2025-06-06 07:47:34
Previous
HotelIdList
Next
Region
Built with