Join our community at https://www.reddit.com/r/HotelByte/

HotelByte
HomepageWaitlist
HomepageWaitlist
Hotel Partners Roadmap
Submit issues
  1. Search
  • 1. Get started
    • Overview
    • Booking flow
    • Certification and Go Live
    • Frequently Asked Questions (FAQ)
  • 2. Guides
    • Quick start
    • Error handling
    • Rate limit
    • Certification cases
    • Test more scenarios
  • 3. API Reference
    • Authentication
      • Ticket
    • Content
      • Destinations
      • HotelStaticDetail
      • HotelsMetadata
    • Search
      • HotelList
        POST
      • HotelRates
        POST
    • Make bookings
      • CheckAvail
      • Book
    • Manage bookings
      • QueryOrders
      • Cancel
  • Schemas
    • Schemas
    • hotel.common.bff.Table
    • OrderHomeFunctionReq
    • TicketReq
    • TicketResp
    • DestinationInclude
    • DestinationExtra
    • Coordinates
    • CheckAvailReq
    • CheckAvailResp
    • HotelsMetadataListResp
    • HotelsMetadataReq
    • ComputedCancelPolicyItem
    • OrderHomeFunctionResp
    • OriginalRoomNaming
    • Rate
    • CancelResp
    • Tax
    • Holder
    • HotelOrder
    • OrderRoomRefundInfo
    • HotelListReq
    • HotelListResp
    • HotelListBasicInfo
    • BaseHeader
    • BookingHeader
    • ContentHeader
    • HotelMeta
    • DestinationType
    • Guest
    • DestinationsReq
    • DestinationsResp
    • OrderStatus
    • GuestPerRoom
    • RatePkgId
    • RoomRatePkg
    • HotelRatesReq
    • BookReq
    • HotelRatesResp
    • BookResp
    • CancelReq
    • QueryOrdersReq
    • HotelStaticDetailReq
    • QueryOrdersResp
    • HotelStaticDetailResp
  1. Search

HotelList

HotelByte OpenAPI - Test
https://api-test.hotelbyte.com
HotelByte OpenAPI - Test
https://api-test.hotelbyte.com
POST
https://api-test.hotelbyte.com
/api/search/hotelList
OpenapiResourceSearch
Search for hotels with flexible criteria including destination, dates, and guest configuration.
This endpoint provides comprehensive hotel search functionality with multiple search methods and optional room availability information. It supports various filtering and sorting options.
Search Methods:
1.
By Specific SupplierHotelList: Get detailed information for specific hotel IDs
2.
By Destination: Search hotels within a destination (by ID or name)
3.
By Location: Find hotels near a specific location (distance-based)
Required Parameters:
checkIn/checkOut: Check-in and check-out dates
occupancies: Guest and room configuration
Optional Parameters:
destinationId: Destination ID for location-based search
destinationName: Destination name (auto-resolved to ID if provided)
hotelIds: Specific hotel IDs to retrieve
maxRatesPerHotel: Maximum room rates per hotel (default: 0)
sortBy: Sort order (price-asc, price-desc, rating-desc, distance-asc)
page: Pagination parameters
Response Features:
Hotel list with basic information
Optional room availability and pricing
Pagination support for large result sets
Session tracking for search context
Common Use Cases:
Hotel booking search interfaces
Destination-based hotel discovery
Specific hotel information lookup
Location-based hotel recommendations

Request

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200成功
application/json
OK
Body

🟠400请求有误
🟠401未认证
🟠403权限不足
🟠429请求过多
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api-test.hotelbyte.com/api/search/hotelList' \
--header 'Client-Request-Timestamp;' \
--header 'Currency;' \
--header 'IP;' \
--header 'Language;' \
--header 'Request-Id;' \
--header 'Session-Id;' \
--header 'Test;' \
--header 'Timeout-Milliseconds;' \
--header 'Trace-Id;' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "hotelIds": [
        "461850557",
        "118062388"
    ],
    "maxRatesPerHotel": 1,
    "checkIn": "now()",
    "checkOut": "now()+7",
    "countryCode": "US",
    "residencyCode": "US",
    "nationalityCode": "US",
    "roomOccupancies": [
        {
            "adultCount": 2,
            "childrenAges": [
                2
            ]
        }
    ],
    "destinationId": "804028047",
    "destinationName": "Dubai",
    "pageNum": 1,
    "pageSize": 10,
    "cursor": 0,
    "sortBy": "price-desc"
}'
Response Response Example
{
    "code": 0,
    "msg": "string",
    "data": {
        "list": [
            {
                "id": "461850557",
                "destinationId": "804028047",
                "name": {
                    "en": "Jumeirah Beach Hotel"
                },
                "rating": 4.5,
                "address": {
                    "en": "Millenium Al Barsha"
                },
                "latlngCoordinator": {
                    "google": {
                        "lat": 25.0478,
                        "lng": 121.5319
                    },
                    "gaode": {
                        "lat": 25.0478,
                        "lng": 121.5319
                    }
                },
                "logoURL": "https://static.hotelbyte.com/Images/Hotel/804028047_1.jpg",
                "minPrice": {
                    "amount": 100,
                    "currency": "USD"
                },
                "minPricesByCurrency": [
                    {
                        "amount": 700,
                        "currency": "CNY"
                    },
                    {
                        "amount": 85,
                        "currency": "EUR"
                    }
                ],
                "isAvailable": true,
                "rooms": [
                    {
                        "roomTypeId": "string",
                        "roomTypeName": {
                            "en": "string",
                            "zh": "string",
                            "ar": "string"
                        },
                        "hotelId": "string",
                        "rates": [
                            {
                                "ratePkgId": "string",
                                "refundableMode": "full",
                                "refundableUntil": "2006-01-02T15:04:05Z07:00",
                                "cancelFees": [
                                    {
                                        "until": "2006-01-02T15:04:05Z07:00",
                                        "fee": {
                                            "currency": "string",
                                            "amount": 0
                                        }
                                    }
                                ],
                                "originalRoomNaming": {
                                    "id": "string",
                                    "name": "string",
                                    "supplier": 0
                                },
                                "rate": {
                                    "commissionableRate": {
                                        "currency": "string",
                                        "amount": 0
                                    },
                                    "netRate": {
                                        "currency": "string",
                                        "amount": 0
                                    },
                                    "grossRate": {
                                        "currency": "string",
                                        "amount": 0
                                    },
                                    "respectGrossRate": true
                                },
                                "totalRate": {
                                    "commissionableRate": {
                                        "currency": "string",
                                        "amount": 0
                                    },
                                    "netRate": {
                                        "currency": "string",
                                        "amount": 0
                                    },
                                    "grossRate": {
                                        "currency": "string",
                                        "amount": 0
                                    },
                                    "respectGrossRate": true
                                },
                                "rateComment": "string",
                                "includesPackaging": true,
                                "checkIn": "now()",
                                "checkOut": "now()+7",
                                "board": {
                                    "boardId": "RO",
                                    "boardName": {
                                        "en": "string",
                                        "zh": "string",
                                        "ar": "string"
                                    },
                                    "boardDesc": {
                                        "en": "string",
                                        "zh": "string",
                                        "ar": "string"
                                    }
                                },
                                "tax": {
                                    "total": {
                                        "currency": "string",
                                        "amount": 0
                                    },
                                    "items": [
                                        {
                                            "taxType": "string",
                                            "taxName": "string",
                                            "amount": {
                                                "currency": "string",
                                                "amount": 0
                                            },
                                            "desc": "string"
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                ]
            }
        ],
        "basic": {
            "destination": {
                "id": "804028047",
                "name": {
                    "en": "Dubai"
                }
            },
            "sessionId": "374337a797454a344ad999c7730da01c"
        },
        "total": 100,
        "hasMore": true
    }
}
Previous
HotelsMetadata
Next
HotelRates
Built with