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
  • Schemas
    • Schemas
      • hotel.api.protocol.ForgetPasswordReq
      • hotel.api.protocol.ForgetPasswordResp
      • hotel.api.protocol.LoginReq
      • hotel.api.protocol.LoginResp
      • hotel.api.protocol.ResetPasswordReq
      • hotel.api.protocol.ResetPasswordResp
      • hotel.api.protocol.TenantAdminHomepageReq
      • hotel.api.protocol.TenantAdminHomepageResp
      • hotel.api.protocol.TicketReq
      • hotel.api.protocol.TicketResp
      • hotel.bi.domain.Order
      • hotel.common.bff.ButtonList
      • hotel.common.bff.Element
      • hotel.common.bff.NavigationTab
      • hotel.common.bff.Table
      • hotel.common.bff.TableEntityRow
      • hotel.common.bff.TableUserRow
      • hotel.common.bizerr.AuthenticationErr
      • hotel.common.bizerr.CrossTenantErr
      • hotel.common.bizerr.DependencyErr
      • hotel.common.bizerr.DuplicateErr
      • hotel.common.bizerr.EmptyCtxTenantErr
      • hotel.common.bizerr.ExpiredErr
      • hotel.common.bizerr.NotFoundErr
      • hotel.common.bizerr.NotImplementedErr
      • hotel.common.bizerr.NotMatchedErr
      • hotel.common.bizerr.PageSizeExceedLimitErr
      • hotel.common.bizerr.ParamErr
      • hotel.common.bizerr.PermissionDeniedErr
      • hotel.common.bizerr.RateLimitErr
      • hotel.common.bizerr.SystemErr
      • hotel.common.bizerr.TimeoutErr
      • hotel.common.httphelper.BaseResp
      • hotel.common.httphelper.GeneralResponse
      • hotel.common.httphelper.Response
      • hotel.common.i18n.I18N
      • hotel.common.money.Money
      • hotel.common.pagehelper.PageReq
      • hotel.common.pagehelper.PageResp
      • hotel.common.protocol.AuthOption
      • hotel.common.protocol.ClientOption
      • hotel.common.protocol.CurrencyOption
      • hotel.common.protocol.Header
      • hotel.common.protocol.LanguageOption
      • hotel.common.protocol.SessionOption
      • hotel.common.protocol.TenantAdminHeader
      • hotel.common.protocol.TestOption
      • hotel.common.protocol.TestScenario
      • hotel.common.protocol.TimeoutOption
      • hotel.common.protocol.TraceOption
      • hotel.common.utils.DateInt
      • hotel.common.utils.FileFinder
      • hotel.common.utils.UnsupportedTypeError
      • hotel.geography.domain.BoundingPolygon
      • hotel.geography.domain.Coordinates
      • hotel.geography.domain.DeprecatedBDCtripHotelCity
      • hotel.geography.domain.DeprecatedCtripHotelCity
      • hotel.geography.domain.Extra
      • hotel.geography.domain.FuzzySearcher
      • hotel.geography.domain.GeoPoint
      • hotel.geography.domain.GeoSource
      • hotel.geography.domain.HierarchySearcher
      • hotel.geography.domain.IndexManager
      • hotel.geography.domain.Latlng
      • hotel.geography.domain.LatlngCoordinator
      • hotel.geography.domain.Place
      • hotel.geography.domain.Region
      • hotel.geography.domain.RegionRepository
      • hotel.geography.domain.RegionType
      • hotel.geography.domain.SupplierID
      • hotel.geography.protocol.FuzzySearchReq
      • hotel.geography.protocol.FuzzySearchResp
      • hotel.mapping.domain.MappedRoomInfo
      • hotel.mapping.domain.RoomInfo
      • hotel.mapping.domain.RoomKey
      • hotel.mapping.domain.RoomMatch
      • hotel.mapping.domain.RoomMatchSupplierItem
      • hotel.mapping.domain.RoomMatchingReq
      • hotel.mapping.domain.RoomMatchingResp
      • hotel.notify.email.protocol.SendEmailReq
      • hotel.notify.email.protocol.SendEmailResp
      • hotel.rule.domain.Rule
      • hotel.rule.domain.Status
      • hotel.rule.protocol.IDReq
      • hotel.rule.protocol.SimulateRuleReq
      • hotel.rule.protocol.SimulateRuleResp
      • hotel.search.domain.Hotel
      • hotel.search.domain.HotelLoyaltyProgram
      • hotel.search.domain.HotelStaticProfile
      • hotel.search.domain.HotelSupplierRef
      • hotel.search.domain.PairDistance
      • hotel.search.protocol.CheckAvailReq
      • hotel.search.protocol.CheckAvailResp
      • hotel.search.protocol.HotelDetailReq
      • hotel.search.protocol.HotelDetailResp
      • hotel.search.protocol.HotelIDListReq
      • hotel.search.protocol.HotelIDListResp
      • hotel.search.protocol.HotelId
      • hotel.search.protocol.HotelListBasicInfo
      • hotel.search.protocol.HotelListFilter
      • hotel.search.protocol.HotelListReq
      • hotel.search.protocol.HotelListResp
      • hotel.search.protocol.HotelRegion
      • hotel.search.protocol.RegionInclude
      • hotel.search.protocol.RegionReq
      • hotel.search.protocol.RegionResp
      • hotel.search.protocol.RegionsReq
      • hotel.search.protocol.RegionsResp
      • hotel.supplier.domain.Amenity
      • hotel.supplier.domain.ArrivalAndDeparturePolicy
      • hotel.supplier.domain.BalanceType
      • hotel.supplier.domain.BaseRequestContextPayload
      • hotel.supplier.domain.BaseResp
      • hotel.supplier.domain.BedOption
      • hotel.supplier.domain.BedType
      • hotel.supplier.domain.BedTypeInfo
      • hotel.supplier.domain.BizType
      • hotel.supplier.domain.BookReq
      • hotel.supplier.domain.BookResp
      • hotel.supplier.domain.Booker
      • hotel.supplier.domain.BrandGroupType
      • hotel.supplier.domain.BrandItem
      • hotel.supplier.domain.CancelMethod
      • hotel.supplier.domain.CancelPolicy
      • hotel.supplier.domain.CancelPolicyItem
      • hotel.supplier.domain.CancelPolicyType
      • hotel.supplier.domain.CancelReq
      • hotel.supplier.domain.CancelResp
      • hotel.supplier.domain.CancelType
      • hotel.supplier.domain.CertificateType
      • hotel.supplier.domain.CheckAvailReq
      • hotel.supplier.domain.CheckAvailResp
      • hotel.supplier.domain.CheckAvailStatus
      • hotel.supplier.domain.CheckInOut
      • hotel.supplier.domain.ChildBedType
      • hotel.supplier.domain.CityHotelBrands
      • hotel.supplier.domain.ConfirmType
      • hotel.supplier.domain.CoordinateInfo
      • hotel.supplier.domain.CountryOption
      • hotel.supplier.domain.CurrencyOption
      • hotel.supplier.domain.DailyMealInfo
      • hotel.supplier.domain.DailyRate
      • hotel.supplier.domain.DistanceFilter
      • hotel.supplier.domain.Domain
      • hotel.supplier.domain.DomesticZoneOrderEnum
      • hotel.supplier.domain.EventType
      • hotel.supplier.domain.ExtendStay
      • hotel.supplier.domain.FacilityGroup
      • hotel.supplier.domain.FacilityItem
      • hotel.supplier.domain.FacilityLimitEnum
      • hotel.supplier.domain.GroupedBedTypeInfo
      • hotel.supplier.domain.Guest
      • hotel.supplier.domain.GuestRoomOption
      • hotel.supplier.domain.HotelBasic
      • hotel.supplier.domain.HotelBrandGroupFilter
      • hotel.supplier.domain.HotelBrandInfo
      • hotel.supplier.domain.HotelBrandInfoReq
      • hotel.supplier.domain.HotelBrandInfoResp
      • hotel.supplier.domain.HotelGuest
      • hotel.supplier.domain.HotelListFilter
      • hotel.supplier.domain.HotelListItem
      • hotel.supplier.domain.HotelListReq
      • hotel.supplier.domain.HotelListResp
      • hotel.supplier.domain.HotelOrder
      • hotel.supplier.domain.HotelPicture
      • hotel.supplier.domain.HotelPolicy
      • hotel.supplier.domain.HotelRatePlanReq
      • hotel.supplier.domain.HotelRatePlanResp
      • hotel.supplier.domain.HotelRefundInfo
      • hotel.supplier.domain.HotelRegion
      • hotel.supplier.domain.HotelStaticDetailReq
      • hotel.supplier.domain.HotelStaticDetailResp
      • hotel.supplier.domain.KeywordEnum
      • hotel.supplier.domain.KeywordFilter
      • hotel.supplier.domain.KeywordTypeEnum
      • hotel.supplier.domain.LadderDeductionDetail
      • hotel.supplier.domain.LadderDeductionInfo
      • hotel.supplier.domain.LanguageOption
      • hotel.supplier.domain.LocationTime
      • hotel.supplier.domain.MapType
      • hotel.supplier.domain.Meal
      • hotel.supplier.domain.MealPolicy
      • hotel.supplier.domain.MealType
      • hotel.supplier.domain.MemberCardInfo
      • hotel.supplier.domain.MetroObjectTypeEnum
      • hotel.supplier.domain.Occupancy
      • hotel.supplier.domain.OrderBasic
      • hotel.supplier.domain.OrderHotelInfo
      • hotel.supplier.domain.OrderRoomInfo
      • hotel.supplier.domain.OrderStatus
      • hotel.supplier.domain.OrderType
      • hotel.supplier.domain.PayType
      • hotel.supplier.domain.Payment
      • hotel.supplier.domain.PaymentOption
      • hotel.supplier.domain.PersonPrice
      • hotel.supplier.domain.PriceFilter
      • hotel.supplier.domain.QueryOrderReq
      • hotel.supplier.domain.QueryOrderResp
      • hotel.supplier.domain.QueryOrdersReq
      • hotel.supplier.domain.QueryOrdersResp
      • hotel.supplier.domain.Ranking
      • hotel.supplier.domain.Rate
      • hotel.supplier.domain.RatePlan
      • hotel.supplier.domain.RatingFilter
      • hotel.supplier.domain.RatingInfo
      • hotel.supplier.domain.RebookStatus
      • hotel.supplier.domain.RefundableMode
      • hotel.supplier.domain.Room
      • hotel.supplier.domain.RoomDayDetail
      • hotel.supplier.domain.RoomDetail
      • hotel.supplier.domain.RoomMealInfo
      • hotel.supplier.domain.RoomPayType
      • hotel.supplier.domain.RoomRatePkg
      • hotel.supplier.domain.RoomStatus
      • hotel.supplier.domain.RoomType
      • hotel.supplier.domain.SearchSortName
      • hotel.supplier.domain.SearchSortType
      • hotel.supplier.domain.SessionOption
      • hotel.supplier.domain.Supplier
      • hotel.supplier.domain.TagEnum
      • hotel.supplier.domain.TagFilter
      • hotel.supplier.domain.Tax
      • hotel.supplier.domain.TaxDetail
      • hotel.supplier.domain.TestOption
      • hotel.supplier.domain.TimeWindow
      • hotel.supplier.domain.TimeoutOption
      • hotel.supplier.domain.WindowType
      • hotel.trade.domain.AddOrderResp
      • hotel.trade.domain.CreateOrderReq
      • hotel.trade.domain.Order
      • hotel.trade.domain.OrderAccount
      • hotel.trade.domain.OrderRoom
      • hotel.trade.domain.OrderRoomRefundInfo
      • hotel.trade.domain.OrderStateMachine
      • hotel.trade.domain.OrderStatus
      • hotel.trade.domain.PayOrderReq
      • hotel.trade.domain.PayOrderResp
      • hotel.trade.domain.RefundOrderRequest
      • hotel.trade.domain.SupplierOrder
      • hotel.trade.protocol.BookReq
      • hotel.trade.protocol.BookResp
      • hotel.trade.protocol.CancelReq
      • hotel.trade.protocol.CancelResp
      • hotel.trade.protocol.OrderIDOption
      • hotel.trade.protocol.QueryOrderCriteria
      • hotel.trade.protocol.QueryOrdersReq
      • hotel.trade.protocol.QueryOrdersResp
      • hotel.user.domain.AuditLog
      • hotel.user.domain.AuditLogDetail
      • hotel.user.domain.CustomerLoginUserWrapper
      • hotel.user.domain.Description
      • hotel.user.domain.DistributionConfig
      • hotel.user.domain.Entity
      • hotel.user.domain.EntityConfigs
      • hotel.user.domain.EntityList
      • hotel.user.domain.EntityProfile
      • hotel.user.domain.EntityType
      • hotel.user.domain.EntityUser
      • hotel.user.domain.FinanceConfig
      • hotel.user.domain.OTP
      • hotel.user.domain.PlatformLoginUserWrapper
      • hotel.user.domain.Privilege
      • hotel.user.domain.PrivilegeCode
      • hotel.user.domain.Role
      • hotel.user.domain.RoleList
      • hotel.user.domain.Scope
      • hotel.user.domain.Status
      • hotel.user.domain.SupplierConfig
      • hotel.user.domain.SupplierCredential
      • hotel.user.domain.SupplierEmailConfig
      • hotel.user.domain.TenantLoginUserWrapper
      • hotel.user.domain.User
      • hotel.user.domain.UserBasic
      • hotel.user.domain.UserEntityRoles
      • hotel.user.domain.UserProfile
      • hotel.user.domain.UserRole
      • hotel.user.domain.tenantContext
      • hotel.user.domain.tenantType
      • hotel.user.protocol.ActivatetenantUserReq
      • hotel.user.protocol.ActivatetenantUserResp
      • hotel.user.protocol.CreateEntityReq
      • hotel.user.protocol.CreateEntityResp
      • hotel.user.protocol.CreatePrivilegeReq
      • hotel.user.protocol.CreateRoleReq
      • hotel.user.protocol.EntityInvitationInfo
      • hotel.user.protocol.EntityRow
      • hotel.user.protocol.GetInvitationInfoReq
      • hotel.user.protocol.GetInvitationInfoResp
      • hotel.user.protocol.GetUserReq
      • hotel.user.protocol.GetUserResp
      • hotel.user.protocol.InviteUserReq
      • hotel.user.protocol.InviteUserResp
      • hotel.user.protocol.ListEntityReq
      • hotel.user.protocol.ListEntityResp[EntityRow]
      • hotel.user.protocol.ListUserReq
      • hotel.user.protocol.ListUserResp[UserRow]
      • hotel.user.protocol.ReSendInvitationReq
      • hotel.user.protocol.ReSendInvitationResp
      • hotel.user.protocol.RegisterCustomerUserReq
      • hotel.user.protocol.RegisterPlatformUserReq
      • hotel.user.protocol.RegisterPlatformUserResp
      • hotel.user.protocol.RegisterUserReq
      • hotel.user.protocol.RegisterUserResp
      • hotel.user.protocol.SendOTPReq
      • hotel.user.protocol.SendOTPResp
      • hotel.user.protocol.UpdateEntityReq
      • hotel.user.protocol.UpdateEntityResp
      • hotel.user.protocol.UpdateUserAction
      • hotel.user.protocol.UpdateUserReq
      • hotel.user.protocol.UpdateUserResp
      • hotel.user.protocol.UserRoleToEntities
      • hotel.user.protocol.UserRow
      • hotel.user.protocol.VerifyLinkReq
      • hotel.user.protocol.VerifyLinkResp
      • hotel.user.protocol.VerifyOTPReq
      • hotel.user.protocol.VerifyOTPResp
  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