API文档

配置接口

接口列表

接口名称 接口方法 说明
1.查询酒店房量房价 Hotel.SearchOrgWithRoomPriceAndRoomCount 可以根据商圈/地理位置/客源/星级及服务标签等分页查询某一时间段符合条件的酒店的房价房量
2.查询某个酒店信息 Hotel.GetOrgInfo 查询某个酒店的基本信息
3.查询酒店信息 Hotel.GetOrgs 提供根据经纬度/距离/城市/酒店名称/服务标签查询酒店的功能，该接口有分页功能
4.查询会员时租价格 Hotel.GetMemberHourRentPrice 查询不同会员级别，不同时租房的数量及价格
5.查询可用房间 Hotel.GetAvailableRooms 该接口可按照抵店和离店时间、楼栋和楼层号等条件查询酒店可用房
6.添加房间评论 Hotel.AddRoomRemark 该接口提供了添加酒店房间评论功能，客户可以通过此接口对酒店在住时或退房时的房间进行评论给酒店反馈意见
7.查询我的房间评论 Hotel.GetMyRoomRemarks 该接口可按照酒店Id、入住Id及会员Id查询自己的房间评论
8.查询酒店小商品 Hotel.GetOrgGoods 查询酒店可售的小商品的数量价格
9.查询酒店房型信息 Hotel.GetOrgRoomTypes 查询酒店的房型信息，包括物理房型和虚拟房型。
10.查询渠道房量配额 Hotel.GetChannelQuota 查询酒店房型在渠道中配置的可售数量
11.查询房态 Hotel.GetRoomStatus 查询酒店房间状态
12.申请查房 Hotel.ApplyRounds 申请查房
13.根据编号查询查房状态 Hotel.GetRoundsByIds 根据申请的查房ID查询查房状态
14.查询酒店评论 Hotel.GetRoomRemarks 查询酒店所有评论
15.查询酒店状态变更记录 Hotel.GetHotelStatsChangedRecords 查询酒店状态变更记录
16.更新酒店信息 Hotel.UpdateOrgByOrgId 根据酒店ID更新酒店信息
17.查询酒店当前营业日 Hotel.GetBusinessDate 根据酒店编号获取当前营业日期
18.查询酒店是否在渠道上线 Hotel.QueryHotelIsOnline 根据酒店编号和渠道查询酒店是否在该渠道上线
19.修改酒店房间锁房状态 Hotel.ModifyRoomLockStatus 修改酒店房间锁房状态
20.查询酒店房间信息列表 Hotel.GetRoomInfos 查询酒店房间信息列表

1.查询酒店房量房价

Hotel.SearchOrgWithRoomPriceAndRoomCount

应用场景

该接口提供了查询酒店及房量房价的功能，客户可以通过此接口查询客人周边的酒店，按照城市查询酒店，按照酒店的服务查询酒店，查询酒店的房价，查询不同会员级别、不同房型的价格等。此接口不仅提供酒店的基本信息，还会提供查询到的酒店的房价和房量信息。

在以下情况下需要调用此接口：

  1. ◆ 客人在酒店的网站、微信上查询酒店
  2. ◆ 客人在自助机上查询本酒店的房价进行预订
  3. ◆ 查询酒店房量房价

请求参数

字段名 变量名 必填 类型 示例值 描述
预计入住时间 ArriveTime 是 Datetime 2017-11-16 13:30:00 入住时间和离店时间用于查询此时间段内的房价、房量。
预计离店时间 DepartureTime 是 Datetime 2017-11-16 13:30:00
酒店Ids OrgIds 否 long[] [660762578567209,660762578567207] 要查询的酒店的标识
酒店名称 OrgName 否 String 小小酒店 要查询的酒店的名称
酒店编号 OrgSns 否 string[] ["hotel1","hotel2"]
城市Id CityId 否 String 0201
区域 DistrictId 否 String 闵行区
星级评分 Star 否 int 5
商圈 CommercialLocationId 否 string
纬度 Latitude 否 decimal 31.114186 1. 要么经度+纬度,此时的距离默认是1000米，即默认搜索1000米内的酒店，要么经度+纬度+距离;
2. 距离的单位是米
经度 Longitude 否 decimal 121.384164
距离 Distance 否 int 2000
服务标签 ServiceTags 否 string[] ["24小时热水","WiFi"]
是否只查询开放接口的酒店信息 OnlyOpenedOrg 是 bool true
入住类型 CheckinType 否 string Normal 默认是Normal(见数据字典)
要查询的房型Id RoomTypeIds 否 string[] ["TR","TD"]
房态 RoomStatuses 否 string[] ["VC","VD"] 查询可用房量时要计算的房态的房间
会员级别 MemberLevels 否 string[] ["G","S"] 要查询的会员级别的房价,散客价格可以传入[""]获取
只查询物理房型 PhysicalRoomTypeOnly 是 bool false 如果为false，则结果中也会包含虚拟房型的价格
只查询酒店基本信息 BasicInfoOnly 是 bool false 其值决定查询结果中是否包含房价房量信息
包含每天的房量信息 IncludeDetailCounts 是 bool false 是否包含查询时间段内每天的房量信息
包含房价信息 IncludePrices 是 bool false 其值决定查询结果中是否包含房价信息
包含房量信息 IncludeRoomCounts 是 bool false 其值决定查询结果中是否包含房量信息
房价码 RateCode 否 string 已不支持,查询匹配了房价码的房价，房价码可以在PMS系统中查看：销售管理->OTA房价码管理
协议公司等级 ContractorLevels 否 string[] ["LevelOne","LevelTwo"] 协议公司等级可在系统配置中查看：系统配置->集团参数配置->系统参数维护，查询ContractCompanyLevel
查询的会员还是协议公司 SearchType 否 string Member或者Contractor 要查询的是会员的价格还是协议公司的价格，默认是会员的价格
排序参数 OrderByRequests 否 OrderByRequest[] 默认按OrgName(酒店名称)排序
分页大小 PageSize 否 int 10
页码 PageIndex 否 int 1

OrderByRequest

字段名 变量名 必填 类型 示例值 描述
排序字段 OrderBy 是 string 目前只支持Star(星级评分),OrgName(酒店名称)排序
是否正序 Asc 是 bool true

示例

                    {
    "ChannelKey": "web",
    "Method": "Hotel.SearchOrgWithRoomPriceAndRoomCount",
    "BizContent": "{\"ArriveTime\":\"2017-11-17 12:31:15\",\"DepartureTime\":\"2017-11-18 12:00:00\",\"OrgIds\":[2147483644],
    \"OrgName\":\"\",\"OrgSns\":[],\"CityId\":\"\",\"DistrictId\":\"\",\"Star\":\"\",\"CommercialLocationId\":\"\",
    \"Latitude\":\"\",\"Longitude\":\"\",\"Distance\":\"\",\"ServiceTags\":[],\"OnlyOpenedOrg\":true,\"CheckinType\":\"Normal\",
    \"RoomTypeIds\":[],\"RoomStatuses\":[],\"MemberLevels\":[],\"PhysicalRoomTypeOnly\":false,\"BasicInfoOnly\":false,
    \"IncludeDetailCounts\":true,\"IncludePrices\":true,\"IncludeRoomCounts\":true,\"RateCode\":\"\",\"ContractorLevels\":[],
    \"SearchType\":\"\",\"OrderByRequests\":[{\"OrderBy\":\"OrgName\",\"Asc\":true}],\"PageSize\":1000,\"PageIndex\":1}",
    "Sign": "1AA56145937EACE6FFC8FC5879A4AE0E",
    "SignType": "MD5",
    "Format": "json",
    "Charset": "utf-8",
    "Version": "1.0",
    "Timestamp": "2017-11-16 10:12:13"
}

其中BizContent是接口参数的json字符串，其json格式如下：

{
    "ArriveTime": "2017-11-16 12:31:15",
    "DepartureTime": "2017-11-17 12:00:00",
    "OrgIds": [
        2147483644
    ],
    "OrgName": "",
    "OrgSns": [],
    "CityId": "",
    "DistrictId": "",
    "Star": "",
    "CommercialLocationId": "",
    "Latitude": "",
    "Longitude": "",
    "Distance": "",
    "ServiceTags": [],
    "OnlyOpenedOrg": true,
    "CheckinType": "Normal",
    "RoomTypeIds": [],
    "RoomStatuses": [],
    "MemberLevels": [],
    "PhysicalRoomTypeOnly": false,
    "BasicInfoOnly": false,
    "IncludeDetailCounts": true,
    "IncludePrices": true,
    "IncludeRoomCounts": true,
    "RateCode": "",
    "ContractorLevels": [],
    "SearchType": "",
    "OrderByRequests": [
        {
            "OrderBy": "OrgName",
            "Asc": true
        }
    ],
    "PageSize": 1000,
    "PageIndex": 1
}

返回结果

字段名 变量名 必填 类型 示例值 描述
酒店Id OrgId 是 long 350075352678405
酒店编号 OrgSn 否 string
酒店名称 OrgName 否 string
品牌 Brand 否 string 酒店所属品牌
地址 Address 否 string
电话 Phone 否 string
传真 Fax 否 string
酒店介绍 Description 否 string
城市Id CityId 否 String 0201
酒店类型 OrgInfoType 否 string 直营、加盟、委托管理
星级评分 Star 否 int
纬度 Latitude 否 decimal
经度 Longitude 否 decimal
服务标签 ServiceTags 否 string[]
房间销售价格 Prices 否 RoomPrice[]
房间最低销售价格 LowestPrices 否 RoomPrice[]
房量信息 RoomCounts 否 RoomCount[]
能否网络锁开门 CanNetOpen 否 bool
图片路径 ImageUris 否 string
装修日期 DecorationDate 否 DateTime
开业时间 OpeningDate 否 DateTime
微信编号ID WeChatLocationId 否 string
全景照片地址 PanoramicSite 否 string
行政区域 DistrictId 否 string
商业区ID CommercialLocationId 否 string
城市名称 CityName 否 string
酒店状态 OrgStatus 否 string

RoomPrice

字段名 变量名 必填 类型 示例值 描述
日期 Date 是 DateTime
门市价 OrignPrice 否 decimal
优惠价 ActualPrice 否 decimal
房型Id RoomTypeId 否 string
房型 RoomType 否 RoomType 房型的详细信息
可用房量 RoomCount 否 int
描述 Description 否 string

RoomType

字段名 变量名 必填 类型 示例值 描述
房型ID Id 是 string
房型名字 RoomTypeName 否 string
房型描述 Description 否 string
酒店房型描述 OrgRoomTypeDescription 否 string
床数 BedAmount 否 int
床型 BedType 否 string
是否虚房型 Virtual 否 bool
物理房型Id PhysicalRoomTypeId 否 string
房型名称缩写 Abbreviation 否 string
是否有效 IsActive 否 bool
房型图片 ImageUris 否 string

RoomCount

字段名 变量名 必填 类型 示例值 描述
房型ID RoomTypeId 否 string
房型信息 RoomType 否 RoomType
最小剩余量 Count 否 int
每日量（按照时间正序排列） DetailCounts 否 int[]
可超卖数 OverbookingCount 否 int

示例

{
        "Code": 10000,
        "Message": null,
        "SubCode": null,
        "SubMessage": null,
        "Data": [
            {
                "OrgId": 2147483644,
                "OrgSn": "X015538",
                "OrgName": "测试门店1",
                "Brand": "99",
                "Address": "人民广场1288号",
                "Phone": "18088888888",
                "Fax": "210-8679888",
                "Description": "体验中国最优质的都市圣地,完美融合了东方美景和西方的惬意。",
                "CityId": "0201",
                "OrgInfoType": "直营",
                "Star": 5,
                "Latitude": 0,
                "Longitude": 0,
                "ServiceTags": [
                    "免费WiFi",
                    "免费停车场"
                ],
                "Prices": [
                    {
                        "Date": "2017-12-17T00:00:00+08:00",
                        "OrignPrice": 400,
                        "ActualPrice": 400,
                        "RoomTypeId": "DR",
                        "RoomType": {
                            "Id": "DR",
                            "RoomTypeName": "DR-DR",
                            "Description": null,
                            "OrgRoomTypeDescription": null,
                            "BedAmount": 2,
                            "BedType": null,
                            "Virtual": false,
                            "PhysicalRoomTypeId": "DR",
                            "Abbreviation": "DR",
                            "IsActive": false,
                            "ImageUris": null
                        },
                        "RoomCount": 0,
                        "Description": "普卡"
                    },
                    {
                        "Date": "2017-12-17T00:00:00+08:00",
                        "OrignPrice": 500,
                        "ActualPrice": 500,
                        "RoomTypeId": "DT",
                        "RoomType": {
                            "Id": "DT",
                            "RoomTypeName": "DT-DT",
                            "Description": null,
                            "OrgRoomTypeDescription": null,
                            "BedAmount": 2,
                            "BedType": null,
                            "Virtual": false,
                            "PhysicalRoomTypeId": "DT",
                            "Abbreviation": "DT",
                            "IsActive": false,
                            "ImageUris": null
                        },
                        "RoomCount": 0,
                        "Description": "非会员"
                    }
                ],
                "LowestPrices": [
                    {
                        "Date": "2017-12-17T00:00:00+08:00",
                        "OrignPrice": 400,
                        "ActualPrice": 400,
                        "RoomTypeId": "DR",
                        "RoomType": {
                            "Id": "DR",
                            "RoomTypeName": "DR-DR",
                            "Description": null,
                            "OrgRoomTypeDescription": null,
                            "BedAmount": 2,
                            "BedType": null,
                            "Virtual": false,
                            "PhysicalRoomTypeId": "DR",
                            "Abbreviation": "DR",
                            "IsActive": false,
                            "ImageUris": null
                        },
                        "RoomCount": 0,
                        "Description": "普卡"
                    },
                    {
                        "Date": "2017-12-17T00:00:00+08:00",
                        "OrignPrice": 400,
                        "ActualPrice": 400,
                        "RoomTypeId": "DR",
                        "RoomType": {
                            "Id": "DR",
                            "RoomTypeName": "DR-DR",
                            "Description": null,
                            "OrgRoomTypeDescription": null,
                            "BedAmount": 2,
                            "BedType": null,
                            "Virtual": false,
                            "PhysicalRoomTypeId": "DR",
                            "Abbreviation": "DR",
                            "IsActive": false,
                            "ImageUris": null
                        },
                        "RoomCount": 0,
                        "Description": "非会员"
                    }
                ],
                "RoomCounts": [
                    {
                        "RoomTypeId": "DR",
                        "RoomType": {
                            "Id": "DR",
                            "RoomTypeName": "DR-DR",
                            "Description": null,
                            "OrgRoomTypeDescription": null,
                            "BedAmount": 2,
                            "BedType": null,
                            "Virtual": false,
                            "PhysicalRoomTypeId": null,
                            "Abbreviation": "DR",
                            "IsActive": false,
                            "ImageUris": null
                        },
                        "Count": 40,
                        "DetailCounts": [
                            40
                        ],
                        "OverbookingCount": 0
                    },
                    {
                        "RoomTypeId": "DT",
                        "RoomType": {
                            "Id": "DT",
                            "RoomTypeName": "DT-DT",
                            "Description": null,
                            "OrgRoomTypeDescription": null,
                            "BedAmount": 2,
                            "BedType": null,
                            "Virtual": false,
                            "PhysicalRoomTypeId": null,
                            "Abbreviation": "DT",
                            "IsActive": false,
                            "ImageUris": null
                        },
                        "Count": 40,
                        "DetailCounts": [
                            40
                        ],
                        "OverbookingCount": 0
                    }
                ],
                "CanNetOpen": null,
                "ImageUris": null,
                "DecorationDate": null,
                "OpeningDate": null,
                "WeChatLocationId": null,
                "PanoramicSite": null,
                "DistrictId": "黄浦区",
                "CommercialLocationId": null,
                "CityName": "上海",
                "OrgStatus": "正式营业"
        }
    ]
}

2.查询某个酒店信息

Hotel.GetOrgInfo

应用场景

该接口可按照酒店Id查询单个酒店的基本信息。

请求参数

字段名 变量名 必填 类型 示例值 描述
酒店Id OrgId 是 long 2147483644 要查询的酒店的标识

示例

{
    "ChannelKey": "Hotel",
    "Method": "Hotel.GetOrgInfo",
    "BizContent": "{\"OrgId\":2147483644}",
    "Sign": "487C37B810B6E565D9E5CF55AC584342",
    "SignType": "MD5",
    "Format": "json",
    "Charset": "utf-8",
    "Version": "1.0",
    "Timestamp": "2017-11-16 10:12:13"
}

返回结果

字段名 变量名 必填 类型 示例值 描述
酒店Id OrgId 是 long 2147483644
酒店编号 OrgSn 否 string
酒店名称 OrgName 否 string
OrgInfoType 否 string 暂时无用
品牌 Brand 否 string 酒店品牌
地址 Address 否 string
电话 Phone 否 string
传真 Fax 否 string
酒店介绍 Description 否 string
酒店类型 OrgInfoType 否 string 直营、加盟、委托管理
星级评分 Star 否 int
经度 Longitude 否 decimal 121.384164
纬度 Latitude 否 int
服务标签 ServiceTags 否 string[] ["24小时热水","WiFi"]
能否网络锁开门 CanNetOpen 否 bool 是否能用网路锁开门
图片路径 ImageUris 否 string
装修时间 DecorationDate 否 Datetime
酒店开业时间 OpeningDate 否 Datetime 酒店什么时候开始开业的
区 DistrictId 否 string
商业区ID CommercialLocationId 否 string
微信编号ID WeChatLocationId 否 string
全景照片地址 PanoramicSite 否 string
城市Id CityId 否 String 0201
城市名称 CityName 否 string 上海,北京
酒店品类 BrandCategory 否 string[]
酒店标签 OrgLabel 否 string[]
酒店状态 StatusName 否 string

示例

{
        "Code": 10000,
        "Message": null,
        "SubCode": null,
        "SubMessage": null,
        "Data": {
            "OrgId": 2147483644,
            "OrgSn": "X015538",
            "OrgName": "测试门店1",
            "OrgInfoType": null,
            "Brand": "99",
            "Address": "人民广场1288号",
            "Phone": "18088888888",
            "Fax": "210-8679888",
            "Description": "体验中国最优质的都市圣地,完美融合了东方美景和西方的惬意。",
            "OrgInfoType": "直营",
            "Star": 5,
            "Longitude": 0,
            "Latitude": 0,
            "ServiceTags": [
                "免费WiFi",
                "免费停车场"
            ],
            "CanNetOpen": null,
            "ImageUris": null,
            "DecorationDate": null,
            "OpeningDate": null,
            "DistrictId": "黄浦区",
            "CommercialLocationId": null,
            "WeChatLocationId": null,
            "PanoramicSite": null,
            "CityId": "0201",
            "CityName": "上海",
            "BrandCategory": [],
            "OrgLabel": [],
            "StatusName": "营业中"
        }
}

3.查询酒店信息

Hotel.GetOrgs

应用场景

该接口可按照酒店所在地理位置的经度和维度、距离、酒店服务、酒店名称、所在城市查询酒店的基本信息。

请求参数

字段名 变量名 必填 类型 示例值 描述
经度 Longitude 否 decimal
纬度 Latitude 否 decimal
距离 Distance 否 int 2000
排序参数 OrderByRequests 否 OrderByRequest[]
服务标签 ServiceTags 否 string[] ["24小时热水","WiFi"]
页码 PageIndex 否 int 1
分页大小 PageSize 否 int 10
酒店名称 OrgName 否 String 小小酒店 要查询的酒店的名称
城市Id CityId 否 String 0201

示例

{
    "ChannelKey": "web",
    "Method": "Hotel.GetOrgs",
    "BizContent": "{\"OrgName\":\"\",\"CityId\":\"\",\"Latitude\":\"\",\"Longitude\":\"\",\"Distance\":\"\",\"ServiceTags\":[],
    \"OrderByRequests\":[{\"OrderBy\":\"OrgName\",\"Asc\":true}],\"PageSize\":1000,\"PageIndex\":1}",
    "Sign": "DCED586FE3B0873C0218099F07C74850",
    "SignType": "MD5",
    "Format": "json",
    "Charset": "utf-8",
    "Version": "1.0",
    "Timestamp": "2017-11-16 10:12:13"
}

其中BizContent是接口参数的json字符串，其json格式如下：

{
    "OrgName":"",
    "CityId\":"",
    "Latitude":"",
    "Longitude":"",
    "Distance":"",
    "ServiceTags":[],
    "OrderByRequests":[
        {
            "OrderBy\":"OrgName",
            "Asc":true
        }
    ],
        "PageSize":1000,
        "PageIndex":1
}

返回结果

字段名 变量名 必填 类型 示例值 描述
酒店Id OrgId 是 long 2147483644
酒店编号 OrgSn 否 string
酒店名称 OrgName 否 string
OrgInfoType 否 string 暂时无用
品牌 Brand 否 string 酒店品牌
地址 Address 否 string
电话 Phone 否 string
传真 Fax 否 string
酒店介绍 Description 否 string
酒店类型 OrgInfoType 否 string 直营、加盟、委托管理
星级评分 Star 否 int
经度 Longitude 否 decimal 121.384164
纬度 Latitude 否 int
服务标签 ServiceTags 否 string[] ["24小时热水","WiFi"]
能否网络锁开门 CanNetOpen 否 bool 是否能用网路锁开门
图片路径 ImageUris 否 string
装修时间 DecorationDate 否 Datetime
酒店开业时间 OpeningDate 否 Datetime 酒店什么时候开始开业的
区 DistrictId 否 string
商业区ID CommercialLocationId 否 string
微信编号ID WeChatLocationId 否 string
全景照片地址 PanoramicSite 否 string
城市Id CityId 否 string
城市名称 CityName 否 string 上海,北京
酒店品类 BrandCategory 否 string[]
酒店标签 OrgLabel 否 string[]

示例

{
        "Code": 10000,
        "Message": null,
        "SubCode": null,
        "SubMessage": null,
        "Data": {
            "PageSize": 1000,
            "PageIndex": 1,
            "RecordCount": 6,
            "PageCount": 1,
            "Content": [
                {
                    "OrgId": 2147483644,
                    "OrgSn": "X015538",
                    "OrgName": "测试门店1",
                    "OrgInfoType": null,
                    "Brand": "99",
                    "Address": "人民广场1288号",
                    "Phone": "18088888888",
                    "Fax": "210-8679888",
                    "Description": "体验中国最优质的都市圣地,完美融合了东方美景和西方的惬意。",
                    "OrgInfoType": "直营",
                    "Star": 5,
                    "Longitude": 0,
                    "Latitude": 0,
                    "ServiceTags": [
                        "免费WiFi",
                        "免费停车场"
                    ],
                    "CanNetOpen": null,
                    "ImageUris": null,
                    "DecorationDate": null,
                    "OpeningDate": null,
                    "DistrictId": "黄浦区",
                    "CommercialLocationId": null,
                    "WeChatLocationId": null,
                    "PanoramicSite": null,
                    "CityId": "0201",
                    "CityName": "上海",
                    "BrandCategory": [],
                    "OrgLabel": []
                },
                {
                    "OrgId": 2147483643,
                    "OrgSn": "X015539",
                    "OrgName": "测试门店2",
                    "OrgInfoType": null,
                    "Brand": "99",
                    "Address": "陆家嘴213号",
                    "Phone": "18088888888",
                    "Fax": "210-8679888",
                    "Description": "体验中国最优质的都市圣地,完美融合了东方美景和西方的惬意。",
                    "OrgInfoType": "加盟",
                    "Star": 5,
                    "Longitude": null,
                    "Latitude": null,
                    "ServiceTags": [
                        "免费WiFi",
                        "早餐"
                    ],
                    "CanNetOpen": null,
                    "ImageUris": null,
                    "DecorationDate": null,
                    "OpeningDate": null,
                    "DistrictId": "浦东区",
                    "CommercialLocationId": null,
                    "WeChatLocationId": null,
                    "PanoramicSite": null,
                    "CityId": "0201",
                    "CityName": "上海",
                    "BrandCategory": [],
                    "OrgLabel": []
                }
            ]
        }
    }

4.查询会员时租价格

Hotel.GetMemberHourRentPrice

应用场景

该接口可按照抵店和离店时间、会员等级查询会员时租价格,包含非会员时租房价格

请求参数

字段名 变量名 必填 类型 示例值 描述
酒店Id OrgId 是 long 2147483644 要查询的酒店的标识
抵店时间 ArriveTime 是 DateTime 2021-01-01 13:00:00
离店时间 DepartureTime 是 DateTime 2021-01-01 16:00:00
会员级别 MemberLevels 否 string[] 如果只想查非会员的房价，可以传：[""]

示例

 {
    "ChannelKey": "web",
    "Method": "Hotel.GetMemberHourRentPrice",
    "BizContent": "{\"OrgId\":2147483644,\"ArriveTime\":\"2017-12-15 07:00:00\",\"DepartureTime\":\"2017-12-15 23:00:00\"}",
    "Sign": "15796C50D2A72B29AB46C853368DBA28",
    "SignType": "MD5",
    "Format": "json",
    "Charset": "utf-8",
    "Version": "1.0",
    "Timestamp": "2017-11-16 10:12:13"
}

返回结果

字段名 变量名 必填 类型 示例值 描述
入住类型 CheckinType 是 string
房间销售价格 Prices 否 RoomPrice[]

示例

{
        "Code": 10000,
        "Message": null,
        "SubCode": null,
        "SubMessage": null,
        "Data": [
            {
                "CheckinType": "Hour3",
                "Prices": [
                    {
                        "Date": "2017-12-15T00:00:00",
                        "OrignPrice": 400,
                        "ActualPrice": 400,
                        "RoomTypeId": "DR",
                        "RoomType": null,
                        "RoomCount": 39,
                        "Description": "普卡"
                    },
                    {
                        "Date": "2017-12-15T00:00:00",
                        "OrignPrice": 400,
                        "ActualPrice": 400,
                        "RoomTypeId": "DR",
                        "RoomType": null,
                        "RoomCount": 39,
                        "Description": "金卡"
                    }
                ]
            },
            {
                "CheckinType": "Hour4",
                "Prices": [
                    {
                        "Date": "2017-12-15T00:00:00",
                        "OrignPrice": 400,
                        "ActualPrice": 400,
                        "RoomTypeId": "DR",
                        "RoomType": null,
                        "RoomCount": 39,
                        "Description": "普卡"
                    },
                    {
                        "Date": "2017-12-15T00:00:00",
                        "OrignPrice": 400,
                        "ActualPrice": 400,
                        "RoomTypeId": "DR",
                        "RoomType": null,
                        "RoomCount": 39,
                        "Description": "金卡"
                    }
                ]
            }
        ]
    }

5.查询可用房间

Hotel.GetAvailableRooms

应用场景

该接口可按照抵店和离店时间、楼栋和楼层号等条件查询酒店可用房

请求参数

字段名 变量名 必填 类型 示例值 描述
酒店Id OrgId 是 long
楼栋号 HallIds 否 List<long>
楼层号 FloorIds 否 List<long>
特性 RoomAttributeIds 否 List<string> 房间特性，比如靠窗？临街？无窗？
房型 RoomTypeIds 否 List<string> ["DR","DT","TR"]
房间状态 RoomStatuses 否 string[] ["VC","VD"] 房间状态（空脏，空净，住净,住脏）
抵店时间 ArriveTime 是 DateTime
离店时间 DepartureTime 是 DateTime
入住类型 CheckinType 是 string 正常（Normal），长包（LongTerm），时租（Hour...）(见数据字典)

示例

 {
    "ChannelKey": "web",
    "Method": "Hotel.GetAvailableRooms",
    "BizContent": "{\"OrgId\":2147483644,\"HallIds\":[],\"FloorIds\":[],\"RoomAttributeIds\":[],\"RoomTypeIds\":[\"DR\"],
    \"RoomStatuses\":[],\"ArriveTime\":\"2017-12-15 00:00:00\",\"DepartureTime\":\"2017-12-30 23:00:00\",\"CheckinType\":\"Normal\"}",
    "Sign": "1AD104C40FCAB035CAAB211C0C76F6C9",
    "SignType": "MD5",
    "Format": "json",
    "Charset": "utf-8",
    "Version": "1.0",
    "Timestamp": "2017-11-16 10:12:13"
}

返回结果

字段名 变量名 必填 类型 示例值 描述
房型ID RoomTypeId 是 string
房间号 RoomNumber 否 string
房间状态 Status 否 string
是否有效 IsActive 否 bool
房间特性 Attribute 否 string
楼栋Id HallId 否 long
楼层Id FloorId 否 long
楼层名称 FloorName 否 string
楼层序号 FLoorNumericaName 否 int
最后修改时间 LastModifiedUtcTime 否 DateTime
维护开始时间 MaintainBeginTime 否 DateTime
维护结束时间 MaintainEndTime 否 DateTime
是否锁房 Locked 否 bool
描述 Description 否 string
维护备忘录 MaintainMemo 否 string
能否使用网路门锁 CanNetOpen 否 bool
图片路径 ImageUris 否 string
全景照片地址 PanoramicSite 否 string

示例

{
        "Code": 10000,
        "Message": null,
        "SubCode": null,
        "SubMessage": null,
        "Data": [
            {
                "RoomTypeId": "ST",
                "RoomNumber": "8539",
                "Status": "VC",
                "IsActive": true,
                "Attribute": null,
                "HallId": 99,
                "FloorId": 5,
                "FloorName": "6层",
                "FLoorNumericaName": 5,
                "LastModifiedUtcTime": "2017-12-15T02:01:19.25",
                "MaintainBeginTime": null,
                "MaintainEndTime": null,
                "Locked": false,
                "Description": null,
                "MaintainMemo": null,
                "CanNetOpen": null,
                "ImageUris": null,
                "PanoramicSite": null
            },
            {
                "RoomTypeId": "ST",
                "RoomNumber": "8538",
                "Status": "VC",
                "IsActive": true,
                "Attribute": null,
                "HallId": 99,
                "FloorId": 5,
                "FloorName": "6层",
                "FLoorNumericaName": 5,
                "LastModifiedUtcTime": "2017-12-15T02:01:19.24",
                "MaintainBeginTime": null,
                "MaintainEndTime": null,
                "Locked": false,
                "Description": null,
                "MaintainMemo": null,
                "CanNetOpen": null,
                "ImageUris": null,
                "PanoramicSite": null
            }
        ]
}

6.添加房间评论

Hotel.AddRoomRemark

应用场景

该接口提供了添加酒店房间评论功能，客户可以通过此接口对酒店在住时或退房时的房间进行评论给酒店反馈意见。

在以下情况下需要调用此接口：

  1. ◆ 客人住房后可发表评论
  2. ◆ 客人退房后可发表评论

请求参数

字段名 变量名 必填 类型 示例值 描述
酒店Id OrgId 是 long
客人入住Id CheckinId 是 long
会员Id MemberId 是 string
清扫打分 CleanScore 否 int
设施打分 FacilityScore 否 int
服务打分 ServiceScore 否 int
备注 Remark 是 string
位置打分 LocationScore 否 int
是否还会入住 IsAlsoCheckIn 否 bool

示例

                    {
     "ChannelKey": "web",
     "Method": "Hotel.AddRoomRemark",
     "BizContent": "{"OrgId":2147483644,"CheckinId":676550517161986,"MemberId":"000405590",
     "CleanScore":10,"FacilityScore":10,"ServiceScore":10,"Remark":"测试","LocationScore":100,"IsAlsoCheckIn":true}",
     "Sign": "0F19BEE2813965B2D6B986BC689C432E",
     "SignType": "MD5",
     "Format": "json",
     "Charset": "utf-8","Version": "1.0",
     "Timestamp": "2017-11-16 10:12:13"
}

其中BizContent是接口参数的json字符串，其json格式如下：

{
    "OrgId":2147483644,
    "CheckinId":676550517161986,
    "MemberId":"000405590",
    "CleanScore":10,
    "FacilityScore":10,
    "ServiceScore":10,
    "Remark":"测试",
    "LocationScore":100,
    "IsAlsoCheckIn":true
}

响应参数

示例

{
    "Code": 10000,
    "Message": null,
    "SubCode": null,
    "SubMessage": null,
    "Data": true
}

请参考接口公共参数


业务异常码表

Code
（返回码） 		Message
（返回码描述） 		SubCode
（业务返回码） 		SubMessage
（业务返回码描述） 		解决方案
50000 业务处理失败 hotel.checkin-not-found 入住单不存在
hotel.no-permission-add-room-remark 必须入住人才能为此房间添加评论
hotel.room-number-not-exist 房间号不存在

7.查询我的房间评论

Hotel.GetMyRoomRemarks

应用场景

该接口可按照酒店Id、入住Id及会员Id查询自己的房间评论。

请求参数

字段名 变量名 必填 类型 示例值 描述
酒店Id OrgId 否 long 2147483644 要查询的酒店的标识
客人入住Id CheckinId 否 long
会员Id MemberId 是 String
页码 PageIndex 是 int 1
分页大小 PageSize 是 int 10

示例

{
    "ChannelKey": "web",
    "Method": "Hotel.GetMyRoomRemarks",
    "BizContent": "{"OrgId":2147483644,"CheckinId":676550517161986,"MemberId":"000405590","PageIndex":1,"PageSize":10}",
    "Sign": "186112164AFEDEC3F115E16BFCCF01F0",
    "SignType": "MD5",
    "Format": "json",
    "Charset": "utf-8",
    "Version": "1.0",
    "Timestamp": "2017-11-16 10:12:13"
}

其中BizContent是接口参数的json字符串，其json格式如下：

{
    "OrgId":2147483644,
    "CheckinId":676550517161986,
    "MemberId":"000405590",
    "PageIndex":1,
    "PageSize":10
}

返回结果

字段名 变量名 必填 类型 示例值 描述
酒店Id OrgId 是 long
酒店名称 OrgName 是 string
客人入住Id CheckinId 是 Long
房间号 RoomNumber 是 string
清扫打分 CleanScore 否 int
设施打分 FacilityScore 否 int
服务打分 ServiceScore 否 int
位置 LocationScore 否 int
是否还会入住 IsAlsoCheckIn 否 bool
备注 Remark 否 string
回复内容 ReplyContent 否 string
创建时间 CreateTime 是 DateTime

示例

{
        "Code": 10000,
        "Message": null,
        "SubCode": null,
        "SubMessage": null,
        "Data": {
            "PageSize": 10,
            "PageIndex": 1,
            "RecordCount": 1,
            "PageCount": 1,
            "Content": [
                {
                    "OrgId": 2147483644,
                    "OrgName": "测试门店1",
                    "CheckinId": 676550517161986,
                    "RoomNumber": "测试",
                    "CleanScore": 10,
                    "FacilityScore": 10,
                    "ServiceScore": 10,
                    "LocationScore": 100,
                    "IsAlsoCheckIn": true,
                    "Remark": "测试",
                    "ReplyContent": null,
                    "CreateTime": "2017-12-15T10:20:01.907+08:00"
                    }
                ]
            }
}

8.查询酒店小商品

Hotel.GetOrgGoods

应用场景

该接口可按照酒店标识查询酒店可售小商品

请求参数

字段名 变量名 必填 类型 示例值 描述
酒店Id OrgId 是 long 2147483646 要查询的酒店的标识

示例

                     {
        "ChannelKey": "web",
        "Method": "Hotel.GetOrgGoods",
        "BizContent":"{\"OrgId\":2147483644}",
        "Sign": "79007C84E3B5F04DA4AE8BEC6B14BC21",
        "SignType": "MD5",
        "Format": "json",
        "Charset": "utf-8",
        "Version": "1.0",
        "Timestamp": "2017-11-16 10:12:13"
}

返回结果

字段名 变量名 必填 类型 示例值 描述
商品ID GoodsId 否 string
商品名称 GoodsName 否 string
商品价格 Price 否 decimal
商品总可销售数 Count 否 decimal
商品类别 Category 否 string
商品类别Id CategoryId 否 long
商品父类别Id ParentCategoryId 否 long
商品编号 GoodsNo 否 string
商品计量单位 Unit 否 string 个，条，瓶
是否可食用 IsSaleable 否 bool
是否可售 IsActive 否 bool
商品描述 GoodsDescription 否 string
图片路径 ImageUris 否 string

示例

                    {
            "Code": 10000,
            "Message": null,
            "SubCode": null,
            "SubMessage": null,
            "Data": [
                {
                    "GoodsId": "2147483594",
                    "GoodsName": "冰红茶",
                    "Price": 5.7,
                    "Count": 0,
                    "Category": "饮料",
                    "CategoryId": 2147483597,
                    "ParentCategoryId": 2147483601,
                    "GoodsNo": "htea",
                    "Unit": "瓶",
                    "IsSaleable": true,
                    "IsActive": true,
                    "GoodsDescription": null,
                    "ImageUris": null
                },
                {
                    "GoodsId": "2147483595",
                    "GoodsName": "恒大冰泉",
                    "Price": 3.3,
                    "Count": 0,
                    "Category": "饮料",
                    "CategoryId": 2147483597,
                    "ParentCategoryId": 2147483601,
                    "GoodsNo": "water",
                    "Unit": "瓶",
                    "IsSaleable": true,
                    "IsActive": true,
                    "GoodsDescription": null,
                    "ImageUris": null
                }
            ]
}

9.查询酒店房型信息

Hotel.GetOrgRoomTypes

应用场景

查询酒店的房型信息，包括物理房型和虚拟房型。

请求参数

字段名 变量名 必填 类型 示例值 描述
酒店Id OrgId 是 long 2147483646 要查询的酒店的标识
房型ID RoomTypeId 否 string DR

示例

                     {
                "ChannelKey": "Web",
                "Method": "Hotel.GetOrgRoomTypes",
                "BizContent": "{\"OrgId\":2147483644,\"RoomTypeId\":\"\"}",
                "Sign": "7972AD4C7C163A68C83C732E3F3F370B",
                "SignType": "MD5",
                "Format": "json",
                "Charset": "utf-8",
                "Version": "1.0",
                "Timestamp": "2018-08-24 13:14:27"
            }

返回结果

字段名 变量名 必填 类型 示例值 描述
房型ID RoomTypeId 否 string DRR
物理房型ID PhysicalRoomTypeId 否 string DR
房型名称 RoomTypeName 否 string 大床房
房型简称 Abbreviation 否 string
床的数量 BedCount 否 int 2
床型ID BedTypeId 否 string QUEEN
是否虚拟房型 IsVirtual 否 bool true
床型 BedTypes 否 数组 新版酒店房型使用
其他描述信息 ConfiguredInfo 否 ConfiguredInfo

ConfiguredInfo

字段名 变量名 必填 类型 示例值 描述
酒店描述信息 Description 否 string
图片地址 ImageUri 否 string http://xxx.aaa.com/logo1.jpg|http://xxx.aaa.com/logo2.jpg

BedType

字段名 变量名 必填 类型 示例值 描述
代码 Key 是 string
名称 Name 是 string
描述 Desc 否 string
数量 Count 是 int

示例

                    {
        "Code": 10000,
        "Message": null,
        "SubCode": null,
        "SubMessage": null,
        "Data": [
            {
                "RoomTypeId": "777",
                "PhysicalRoomTypeId": "777",
                "RoomTypeName": "WL",
                "Abbreviation": "WLL",
                "Description": "",
                "ConfiguredInfo": {
                    "Description": null,
                    "ImageUri": null
                },
                "BedCount": 2,
                "BedTypeId": "QUEEN",
                "IsVirtual": false,
                "BedTypes": [
                {
                    "Key": "Twin",
                    "Name": "双人床",
                    "Desc": "2.3x2.0米",
                    "Count": 1
                },
                {
                    "Key": "SmallTwin",
                    "Name": "小型双人床",
                    "Desc": "2.3x2.0米",
                    "Count": 1
                }
                ]
            },
            {
                "RoomTypeId": "DR",
                "PhysicalRoomTypeId": "DR",
                "RoomTypeName": "DR-DR",
                "Abbreviation": "大床房",
                "Description": "大床房，无烟",
                "ConfiguredInfo": {
                    "Description": "风景好",
                    "ImageUri": "http://xxx.aaa.com/logo1.jpg|http://xxx.aaa.com/logo2.jpg"
                },
                "BedCount": 2,
                "BedTypeId": "KING",
                "IsVirtual": false
            },
            {
                "RoomTypeId": "DT",
                "PhysicalRoomTypeId": "DT",
                "RoomTypeName": "DT-DT",
                "Abbreviation": "DT",
                "Description": null,
                "ConfiguredInfo": {
                    "Description": null,
                    "ImageUri": null
                },
                "BedCount": 2,
                "BedTypeId": null,
                "IsVirtual": false
            }
        ]
    }

10.查询渠道房量配额

Hotel.GetChannelQuota

应用场景

查询酒店房型在渠道中配置的可售数量。

请求参数

字段名 变量名 必填 类型 示例值 描述
酒店Id OrgIds 是 long[] 查询的酒店,单次查询不可超过10家
房型ID RoomTypeIds 否 string[]
房型类型 SearchRoomType 是 string All All：查询所有；OnlyPhysicalRoomType：只查询物理房型；OnlyVirtualRoomType、只查询虚房型。 该条件优先于房型条件，比如：设置只查询物理房型，房型条件中包含虚房型则无法查询出虚房型
开始日期 BeginDate 是 DateTime 2019-03-21
结束日期 EndDate 是 DateTime 2019-07-21

示例

                     {
    "ChannelKey": "web",
    "Method": "Hotel.GetChannelQuota",
    "BizContent": "{\"OrgIds\":[2147483644],\"RoomTypeIds\":[\"MZZ\"],\"SearchRoomType\":\"All\",\"BeginDate\":\"2019-03-21\",
                \"EndDate\":\"2019-3-25\"}",
    "Sign": "E55AD346B636B896C4B630D2D65A0587",
    "SignType": "MD5",
    "Format": "json",
    "Charset": "utf-8",
    "Version": "1.0",
    "Timestamp": "2017-11-16 10:12:13"
}

返回结果

字段名 变量名 必填 类型 示例值 描述
酒店ID OrgId 是 long 2108981732
酒店名称 OrgName 是 string 测试酒店
渠道配额信息 ChannelQuotas 是 ChannelQuotaDetail

ChannelQuotaDetail

字段名 变量名 必填 类型 示例值 描述
定价房型 PriceRoomTypeId 是 string
定价房型名称 PriceRoomName 是 string
物理房型 PhysicalRoomTypeId 是 string
物理房型名称 物理房型名称 是 string
是否虚房型 Virtual 是 bool
渠道房量每日配额 ChannelQuotaDailyDetails 是 int[]
每日超预定数量 OverbookingDailyDetails 是 int[]

示例

                    {
    "Code": 10000,
    "Message": null,
    "SubCode": null,
    "SubMessage": null,
    "Data": [
        {
            "OrgId": 2147483644,
            "OrgName": "测试门店1",
            "ChannelQuotas": [
                {
                    "PriceRoomTypeId": "MZZ",
                    "PriceRoomName": "美住",
                    "PhysicalRoomTypeId": "DT",
                    "PhysicalRoomName": "DT-DT",
                    "Virtual": true,
                    "ChannelQuotaDailyDetails": [
                        0,
                        2,
                        2,
                        2,
                        0
                    ],
                    "OverbookingDailyDetails": [
                        0,
                        4,
                        4,
                        4,
                        4
                    ]
                }
            ]
        }
    ]
}

11. 查询房态

Hotel.GetRoomStatus

应用场景

查询房态

请求参数

字段名 变量名 必填 类型 示例值 描述
酒店Id OrgId 是 long 查询的酒店
房间号数组 RoomNos 是 string[] 房间号数组

示例

 {
    "BizContent": "{\"OrgId\":2147483644,\"RoomNos\":[\"8100\",\"8101\"]}",
    "ChannelKey": "Hotel",
    "Charset": "utf-8",
    "Domain": "www",
    "Format": "json",
    "Method": "Hotel.GetRoomStatus",
    "Sign": "c4ef6d97d2097c0ef8c1d735d118c05775d0a0923875b4d9f5bf7b7b2a736395",
    "SignType": "SHA256",
    "Timestamp": "2019-03-02 11:42:00",
    "Version": "1.0"
  }

返回结果

字段名 变量名 必填 类型 示例值 描述
房间号 RoomNo 是 string "8100"
房型 RoomTypeId 是 string
房态 Status 是 string VD=空脏，VC=空净，OOO=维修房，OD=住脏，OC=住净
锁房 Locked 是 bool false
有效 IsActive 是 bool true
维修房开始时间 MaintainBeginTime 否 DateTime
维修房结束时间 MaintainEndTime 否 DateTime
维修房备注 MaintainMemo 否 string

示例

{
    "Code": 10000,
    "Message": null,
    "SubCode": null,
    "SubMessage": null,
    "Data": [
        {
            "RoomNo": "8101",
            "RoomTypeId": "TD",
            "Status": "VC",
            "Locked": false,
            "IsActive": true,
            "MaintainBeginTime": null,
            "MaintainEndTime": null,
            "MaintainMemo": null
        },
        {
            "RoomNo": "8100",
            "RoomTypeId": "TD",
            "Status": "VD",
            "Locked": false,
            "IsActive": true,
            "MaintainBeginTime": null,
            "MaintainEndTime": null,
            "MaintainMemo": null
        }
    ]
}

12. 申请查房

Hotel.ApplyRounds

应用场景

申请查房

请求参数

字段名 变量名 必填 类型 示例值 描述
酒店Id OrgId 是 long 查询的酒店
查房信息 Rounds 是 Rounds[] 房间号数组

Rounds

字段名 变量名 必填 类型 示例值 描述
房型名称 RoomTypeName 是 string
房间号 RoomNumbers 是 string[]

示例


{
	"ChannelKey": "web",
	"Method": "Hotel.ApplyRounds",
	"BizContent": "{\"OrgId\":2147483644,\"Rounds\":[{\"RoomNumbers\":[\"8004\",\"8003\",\"8005\"],\"RoomTypeName\":\"TR-TR\"}]}",
	"Sign": "D5148CD131D9C28DC9ED559EE2475416",
	"SignType": "MD5",
	"Format": "json",
	"Charset": "utf-8",
	"Version": "1.0",
	"Timestamp": "2017-11-16 10:12:13"
}

返回结果

字段名 变量名 必填 类型 示例值 描述
查房ID集合 是 long[]

示例


{
    "Code": 10000,
    "Message": null,
    "SubCode": null,
    "SubMessage": null,
    "Data": [
        903478020374531,
        904711283146753,
        904722662703105
    ]
}

13. 根据编号查询查房状态

Hotel.GetRoundsByIds

应用场景

根据申请的查房ID查询查房状态

请求参数

字段名 变量名 必填 类型 示例值 描述
酒店Id OrgId 是 long 查询的酒店
查房信息编号 RoundsIds 是 long[] 查房信息编号数组

示例


{
    "ChannelKey": "web",
    "Method": "Hotel.GetRoundsByIds",
    "BizContent": "{\"OrgId\":2147483644,\"RoundsIds\":[ 903478020374531]}",
    "Sign": "48D17EC7EA2E8E9CC44A9D6AC01CAEE5",
    "SignType": "MD5",
    "Format": "json",
    "Charset": "utf-8",
    "Version": "1.0",
    "Timestamp": "2017-11-16 10:12:13"
}

返回结果

字段名 变量名 必填 类型 示例值 描述
酒店Id OrgId 是 long
查房ID Id 是 long
房号 RoomNumber 是 string
房型名称 RoomTypeName 是 string
查房状态 StatusId 是 string 待申请: NotApplied;
已申请: Applied;
已确认: Confirmed;
已完成: Completed;
已取消: Cancelled;
查房申请人 ApplicantsName 是 string
查房申请时间 ApplyTimeInUtc 是 string 2019-05-24T09:13:21
修改人 UpdatorName 是 string
修改时间 UpdateTimeInUtc 是 string 2019-05-24T09:13:21

示例


{
    "Code": 10000,
    "Message": null,
    "SubCode": null,
    "SubMessage": null,
    "Data": [
        {
            "OrgId": 2147483644,
            "Id": 903478020374531,
            "RoomNumber": "8003",
            "RoomTypeName": "TR-TR",
            "StatusId": "Applied",
            "ApplicantsName": "OpenApi_Web",
            "ApplyTimeInUtc": "2019-05-24T09:13:21",
            "UpdatorName": null,
            "UpdateTimeInUtc": null
        }
    ]
}

14.查询酒店所有评论

Hotel.GetRoomRemarks

应用场景

获取酒店评论

请求参数

字段名 变量名 必填 类型 示例值 描述
酒店Id OrgId 是 long 2147483644 要查询的酒店的标识
页码 PageIndex 是 int 1
分页大小 PageSize 是 int 10

示例

{
    "ChannelKey": "web",
    "Method": "Hotel.GetRoomRemarks",
    "BizContent": "{\"OrgId\":2147483644,\"PageIndex\":1,\"PageSize\":10}",
    "Sign": "186112164AFEDEC3F115E16BFCCF01F0",
    "SignType": "MD5",
    "Format": "json",
    "Charset": "utf-8",
    "Version": "1.0",
    "Timestamp": "2017-11-16 10:12:13"
}

其中BizContent是接口参数的json字符串，其json格式如下：

{
    "OrgId":2147483644,
    "PageIndex":1,
    "PageSize":10
}

返回结果

字段名 变量名 必填 类型 示例值 描述
酒店Id OrgId 是 long
酒店名称 OrgName 是 string
客人入住Id CheckinId 是 Long
房间号 RoomNumber 是 string
清扫打分 CleanScore 否 int
设施打分 FacilityScore 否 int
服务打分 ServiceScore 否 int
位置 LocationScore 否 int
是否还会入住 IsAlsoCheckIn 否 bool
备注 Remark 否 string
回复内容 ReplyContent 否 string
创建时间 CreateTime 是 DateTime

示例

{
        "Code": 10000,
        "Message": null,
        "SubCode": null,
        "SubMessage": null,
        "Data": {
            "PageSize": 10,
            "PageIndex": 1,
            "RecordCount": 1,
            "PageCount": 1,
            "Content": [
                {
                    "OrgId": 2147483644,
                    "OrgName": "测试门店1",
                    "CheckinId": 676550517161986,
                    "RoomNumber": "测试",
                    "CleanScore": 10,
                    "FacilityScore": 10,
                    "ServiceScore": 10,
                    "LocationScore": 100,
                    "IsAlsoCheckIn": true,
                    "Remark": "测试",
                    "ReplyContent": null,
                    "CreateTime": "2017-12-15T10:20:01.907+08:00"
                    }
                ]
            }
}

15.查询酒店状态变更记录

Hotel.GetHotelStatsChangedRecords

应用场景

查询酒店状态变更记录

请求参数

字段名 变量名 必填 类型 示例值 描述
酒店Id OrgId 否 long 2147483644 要查询的酒店的标识，不传的话默认为集团下所有酒店
开始日期 StartDate 是 DateTime 不传的话默认为当天
结束日期 EndDate 是 DateTime 不传的话默认为当天
页码 PageIndex 是 int 1
分页大小 PageSize 是 int 10

示例

{
    "ChannelKey": "web",
    "Method": "Hotel.GetHotelStatsChangedRecords",
    "BizContent": "{\"OrgId\":2147483644,\"StartDate\":\"2019-07-23\",\"EndDate\":\"2019-07-24\",\"PageIndex\":1,\"PageSize\":20}",
    "Sign": "186112164AFEDEC3F115E16BFCCF01F0",
    "SignType": "MD5",
    "Format": "json",
    "Charset": "utf-8",
    "Version": "1.0",
    "Timestamp": "2019-07-23 15:37:22"
}

其中BizContent是接口参数的json字符串，其json格式如下：

{
    "OrgId":2147483644,
    "StartDate":"2019-07-23",
    "EndDate":"2019-07-24"
    "PageIndex":1,
    "PageSize":10
}

返回结果

字段名 变量名 必填 类型 示例值 描述
酒店Id OrgId 是 long
酒店状态变更日志 Log 是 string

示例

{
        "Code": 10000,
        "Message": null,
        "SubCode": null,
        "SubMessage": null,
        "Data": {
            "PageSize": 10,
            "PageIndex": 1,
            "RecordCount": 1,
            "PageCount": 1,
            "Content": [
                    {
                "OrgId": 2147483644,
                "Log": "修改 [酒店或管理部门 名称:测试门店1, 店长或负责人:张三, 所属上级:华东区, 类型:直营, 启用价税分离:]: 网络开放:原值(),现值(False) 状态:原值(正式营业),现值(筹备中) LBSCityId:原值(),现值(0201) Priority:原值(),现值(0)"
                    }
                   
                ]
            }
}

16.更新酒店信息

Hotel.UpdateOrgByOrgId

应用场景

根据酒店ID更新酒店信息

请求参数

字段名 变量名 必填 类型 示例值 描述
酒店Id OrgId 是 long 2147483644 修改的酒店ID
酒店名称 OrgName 否 string 传入空字符串或者null则不更新
城市ID CityId 否 string 需要按照指定格式，传入空字符串则不更新
地址 Address 否 string 传入空字符串则不更新
电话 Phone 否 string 传入空字符串则不更新
经度 Longitude 是 deciaml 121.459866 传入空值则不更新
纬度 Latitude 是 deciaml 31.220927 传入空值则不更新

示例

 {
    "ChannelKey": "web",
    "Method": "Hotel.UpdateOrgByOrgId",
    "BizContent": "{\"OrgId\":873196951601153,\"OrgName\":\"人民酒店\",\"Longitude\":121.459866,\"Latitude\":31.220927,\"CityId\":\"0201\",\"Address\":\"人民广场1288号2222\",\"Phone\":\"13771713771\"}",
    "Sign": "5C42EE6BE9DD93DEF8FDB7593AF3F6E9",
    "SignType": "MD5",
    "Format": "json",
    "Charset": "utf-8",
    "Version": "1.0",
    "Timestamp": "2017-11-16 10:12:13"
 	
 }

其中BizContent是接口参数的json字符串，其json格式如下：

{
	"OrgId": 873196951601153,
	"OrgName": "人民酒店",
	"Longitude": 121.459866,
	"Latitude": 31.220927,
	"CityId": "0201",
	"Address": "人民广场1288号2222",
	"Phone": "13771713771"
}

返回结果

字段名 变量名 必填 类型 示例值 描述
是 long True

示例

{
    "Code": 10000,
    "Message": null,
    "SubCode": null,
    "SubMessage": null,
    "Sign": "",
    "Data": true
}

17.查询酒店当前营业日

Hotel.GetBusinessDate

应用场景

根据酒店编号获取当前营业日期

请求参数

字段名 变量名 必填 类型 示例值 描述
酒店Id OrgId 是 long 2147483644 查询的酒店Id

示例

                    
                            {
                            "ChannelKey": "web",
                            "Method": "Hotel.GetBusinessDate",
                            "BizContent": "{\"OrgId\":2147483644}",
                            "Sign": "5C42EE6BE9DD93DEF8FDB7593AF3F6E9",
                            "SignType": "MD5",
                            "Format": "json",
                            "Charset": "utf-8",
                            "Version": "1.0",
                            "Timestamp": "2017-11-16 10:12:13"

                            }

其中BizContent是接口参数的json字符串，其json格式如下：

                    
                            {
                            "OrgId":2147483644
                            }

返回结果

字段名 变量名 必填 类型 示例值 描述
是 string 20190925000000

示例

                    
                            {
                            "Code": 10000,
                            "Message": null,
                            "SubCode": null,
                            "SubMessage": null,
                            "Data": "20190925000000"
                            }

18.查询酒店是否在渠道上线

Hotel.QueryHotelIsOnline

应用场景

根据酒店编号和渠道查询酒店是否在该渠道上线

请求参数

字段名 变量名 必填 类型 示例值 描述
酒店Id OrgId 是 long 2147483644 查询的酒店Id
渠道 Channel 是 string Mtop 查询的渠道

示例

                    
                            {
                            "ChannelKey": "web",
                            "Method": "Hotel.QueryHotelIsOnline",
                            "BizContent": "{\"OrgId\":2147483644,\"Channel\":\"Mtop\"}",
                            "Sign": "5C42EE6BE9DD93DEF8FDB7593AF3F6E9",
                            "SignType": "MD5",
                            "Format": "json",
                            "Charset": "utf-8",
                            "Version": "1.0",
                            "Timestamp": "2017-11-16 10:12:13"

                            }

其中BizContent是接口参数的json字符串，其json格式如下：

                    
                            {
                            "OrgId":2147483644,
                            "Channel":"Mtop"
                            }

返回结果

字段名 变量名 必填 类型 示例值 描述
是 bool true

示例

                    
                            {
                            "Code": 10000,
                            "Message": null,
                            "SubCode": null,
                            "SubMessage": null,
                            "Data": true
                            }

19.修改酒店房间锁房状态

Hotel.ModifyRoomLockStatus

应用场景

修改酒店房间锁房状态

请求参数

字段名 变量名 必填 类型 示例值 描述
酒店Id OrgId 是 long 2147483644 查询的酒店Id
房间号 RoomNumber 是 string 8003
状态 IsLocked 是 bool true true：锁房，false：解放
备注 Remark 是 string 测试

示例

                    
                            {
                            "BizContent": "{\"OrgId\":2147483644,\"RoomNumber\":\"8003\",\"Remark\":\"测试\",\"IsLocked\":true}",
                            "ChannelKey": "Hotel",
                            "Charset": "utf-8",
                            "Domain": "www",
                            "Format": "json",
                            "Method": "Hotel.ModifyRoomLockStatus",
                            "Sign": "c4ef6d97d2097c0ef8c1d735d118c05775d0a0923875b4d9f5bf7b7b2a736395",
                            "SignType": "SHA256",
                            "Timestamp": "2019-03-02 11:42:00",
                            "Version": "1.0"
                            }

其中BizContent是接口参数的json字符串，其json格式如下：

                    
                            {
                            "OrgId":2147483644,
                            "RoomNumber":"8003",
                            "Remark":"测试",
                            "IsLocked":true
                            }

返回结果

字段名 变量名 必填 类型 示例值 描述
是 bool true

示例

                    
                            {
                            "Code": 10000,
                            "Message": null,
                            "SubCode": null,
                            "SubMessage": null,
                            "Data": true
                            }

20.查询酒店房间信息列表

Hotel.GetRoomInfos

应用场景

查询酒店房间信息列表

请求参数

字段名 变量名 必填 类型 示例值 描述
酒店Id OrgId 是 long 2147483644 查询的酒店Id
房间号 RoomNumber 否 string 8000 房间号码
房型编码 RoomTypeId 否 string TR 房型编码
房间状态 RoomStatus 否 string VC 常用房间状态：VC：空净，VD：空脏，OOO：维修房，OD：住脏，OC：住净
是否激活 IsActive 否 bool null true:激活使用房间，false：停用房间，null：不过滤该条件

示例

                    
                            {
                            "BizContent": "{\"OrgId\":2147483644,\"RoomNumber\":\"8000\",\"RoomTypeId\": \"TR\",\"RoomStatus\": \"VC\",\"IsActive\": true}",
                            "ChannelKey": "Hotel",
                            "Charset": "utf-8",
                            "Domain": "www",
                            "Format": "json",
                            "Method": "Hotel.GetRoomInfos",
                            "Sign": "c4ef6d97d2097c0ef8c1d735d118c05775d0a0923875b4d9f5bf7b7b2a736395",
                            "SignType": "SHA256",
                            "Timestamp": "2019-03-02 11:42:00",
                            "Version": "1.0"
                            }

其中BizContent是接口参数的json字符串，其json格式如下：

                    
                            {"OrgId":2147483644,"RoomNumber":"8000","RoomTypeId": "TR","RoomStatus": "VC","IsActive": true}

返回结果

字段名 变量名 必填 类型 示例值 描述
房型ID RoomTypeId 是 string
房间号 RoomNumber 是 string
房间状态 Status 是 string 常用房间状态：VC：空净，VD：空脏，OOO：维修房，OD：住脏，OC：住净
是否有效 IsActive 是 bool
房间特性 Attribute 否 string
楼栋Id HallId 否 long
楼栋名称 HallName 否 string
楼栋序号 HallNumericaName 否 string
楼层Id FloorId 否 long
楼层名称 FloorName 否 string
楼层序号 FLoorNumericaName 否 int
最后修改时间 LastModifiedUtcTime 否 DateTime
维护开始时间 MaintainBeginTime 否 DateTime
维护结束时间 MaintainEndTime 否 DateTime
是否锁房 Locked 否 bool
锁房原因 LockMemo 否 string
最近锁房时间 LastLockRoomTime 否 DateTime
描述 Description 否 string
维护备忘录 MaintainMemo 否 string
能否使用网路门锁 CanNetOpen 否 bool
是否是网络门锁 IsNetLock 否 bool
网络锁号 NetLockSn 否 string
图片路径 ImageUris 否 string
全景照片地址 PanoramicSite 否 string
图片路径 ImageUrls 否 string[] ImageUris地址分割后的数组
全景照片地址 PanoramicImageUrls 否 string[] PanoramicSite地址分割后的数组

示例

                    
                            {
                            "Code": 10000,
                            "Message": null,
                            "SubCode": null,
                            "SubMessage": null,
                            "Data": [
                            {
                            "RoomTypeId": "TR",
                            "RoomNumber": "8000",
                            "Status": "VC",
                            "IsActive": true,
                            "Attribute": "",
                            "HallId": 99,
                            "HallName": "一号楼",
                            "HallNumericaName": 1,
                            "FloorId": 0,
                            "FloorName": "1层",
                            "FLoorNumericaName": 0,
                            "LastModifiedUtcTime": "2020-08-04T05:25:12",
                            "MaintainBeginTime": null,
                            "MaintainEndTime": null,
                            "Locked": true,
                            "LockMemo": "测试",
                            "LastLockRoomTime": "2020-08-04T13:24:08",
                            "Description": null,
                            "MaintainMemo": null,
                            "CanNetOpen": false,
                            "IsNetLock": true,
                            "NetLockSn": "8000",
                            "ImageUris": "http://externalimage.qiniu.beyondh.com/f3917c056f865c490b4cd65d5fed801a_20200628152450.jpg|http://externalimage.qiniu.beyondh.com/01f9b9fbdf6e44015fea7edb8eb46db4_20200628152620.jpg",
                            "PanoramicSite": "http://externalimage.qiniu.beyondh.com/669d6458564796a0801dac03a2c3fdc5_20200628152601.jpg|http://externalimage.qiniu.beyondh.com/f3917c056f865c490b4cd65d5fed801a_20200628152610.jpg",
                            "ImageUrls": [
                            "http://externalimage.qiniu.beyondh.com/f3917c056f865c490b4cd65d5fed801a_20200628152450.jpg",
                            "http://externalimage.qiniu.beyondh.com/01f9b9fbdf6e44015fea7edb8eb46db4_20200628152620.jpg"
                            ],
                            "PanoramicImageUrls": [
                            "http://externalimage.qiniu.beyondh.com/669d6458564796a0801dac03a2c3fdc5_20200628152601.jpg",
                            "http://externalimage.qiniu.beyondh.com/f3917c056f865c490b4cd65d5fed801a_20200628152610.jpg"
                            ],
                            "CreateTimeInUtc": "2020-05-28T02:39:39",
                            "LastModifyTimeInUtc": "2020-08-04T05:25:12"
                            }
                            ]
                            }