API文档

房型接口

接口列表

接口名称 接口方法 说明
1.查询床型 RoomType.GetBedTypes 查询PMS床型信息
2.修改酒店房型 RoomType.UpdateOrgRoomType 修改酒店房型
3.查询可选房间的房间特征 RoomType.GetOrderAvailableRoomsAttributes 查询可选房间的房间特征
4.查询房型实时售卖情况 RoomType.GetRealTimeRentRateByRoomTypeId 查询房型实时售卖情况（在住、预抵、预离、维修、出租率）

1.查询床型

RoomType.GetBedTypes

应用场景

查询酒店所有床型,包含床型对应的尺寸规格

请求参数

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

示例

                    
  {
    "ChannelKey": "web",
    "Method": "RoomType.GetBedTypes",
    "BizContent": "{}",
    "Sign": "F79FE48F6CE60F11716A90ED0E2EAE00",
    "SignType": "MD5",
    "Format": "json",
    "Charset": "utf-8",
    "Version": "1.0",
    "Timestamp": "2019-12-26 14:30:16"
   }

返回结果

字段名 变量名 必填 类型 示例值 描述
BedTypeId 床型编码 是 string Single
BedTypeName 床型名称 是 string 单人床
BedTypeSizes 床型对应的尺寸规格 是 string 0.8x2.0米

示例

                
                       {
    "Code": 10000,
    "Message": null,
    "SubCode": null,
    "SubMessage": null,
    "Data": [
        {
            "BedTypeId": "Single",
            "BedTypeName": "单人床",
            "BedTypeSizes": [
                "0.8x2.0米",
                "0.9x2.0米",
                "1.0x2.0米",
                "1.1x2.0米",
                "1.2x1.9米",
                "1.2x2.0米",
                "1.3x2.0米",
                "1.35x2.0米",
                "1.4x2.0米",
                "1.5x2.0米"
            ]
        },
        {
            "BedTypeId": "Large",
            "BedTypeName": "大床",
            "BedTypeSizes": [
                "1.5x2.0米",
                "1.5x1.8米",
                "1.5x1.9米",
                "1.8x2.0米",
                "2.0x2.0米",
                "2.0x2.2米"
            ]
        },
        {
            "BedTypeId": "BunkBeds",
            "BedTypeName": "上下铺",
            "BedTypeSizes": [
                "0.9x2.0米",
                "1.0x2.0米",
                "1.2x2.0米",
                "上铺1.0x2.0米 下铺1.35x2.0米",
                "上铺1.0x2.0米 下铺1.5x2.0米",
                "上铺1.2x2.0米 下铺1.5x2.0米"
            ]
        },
        {
            "BedTypeId": "Round",
            "BedTypeName": "圆床",
            "BedTypeSizes": [
                "直径1.8米",
                "直径2.0米",
                "直径2.2米",
                "直径2.4米",
                "直径2.6米",
                "直径2.8米"
            ]
        },
        {
            "BedTypeId": "SquareWater",
            "BedTypeName": "方形水床",
            "BedTypeSizes": [
                "1.5x1.9米",
                "1.5x2.0米",
                "1.8x2.0米",
                "2.0x2.0米",
                "2.0x2.2米"
            ]
        },
        {
            "BedTypeId": "RoundWater",
            "BedTypeName": "圆形水床",
            "BedTypeSizes": [
                "直径2.0米",
                "直径2.2米",
                "直径2.4米",
                "直径2.6米",
                "直径2.8米"
            ]
        },
        {
            "BedTypeId": "SmallTwin",
            "BedTypeName": "小型双人床",
            "BedTypeSizes": [
                "0.9x2.0米",
                "1.0x2.0米",
                "1.1x2.0米",
                "1.2x2.0米",
                "1.3x2.0米",
                "1.4×2.0米"
            ]
        },
        {
            "BedTypeId": "Twin",
            "BedTypeName": "双人床",
            "BedTypeSizes": [
                "1.3×2.0米",
                "1.4×2.0米",
                "1.5×2.0米"
            ]
        },
        {
            "BedTypeId": "ExtraLarge",
            "BedTypeName": "特大床",
            "BedTypeSizes": [
                "1.9×2.0米",
                "2.0×2.0米",
                "2.1×2.0米",
                "2.2×2.0米",
                "2.3×2.0米",
                "2.4×2.0米",
                "2.5x2.0米"
            ]
        },
        {
            "BedTypeId": "Other",
            "BedTypeName": "其他床",
            "BedTypeSizes": []
        }
    ]
}

2.修改房型接口

RoomType.UpdateOrgRoomType

应用场景

更新门店房型信息（门店房型必须绑定一个门店的房间）

请求参数

字段名 变量名 必填 类型 示例值 描述
OrgId 酒店Id 是 long
RoomTypeId 房型编码 是 string
BedTypes 床型集合 是 BedTypeItem[]
Capacity 可住人数 是 int 大于0
RoomArea 房间面积 是 int 10~20之间
Washroom 房间面积 是 int 0：没有，1：有
Window 有窗情况 是 int 0：有窗，1：部分有，2：没有
Description 描述 否 string
ImageUris 房型图片地址 否 string 字符长度小于1000

BedTypeItem

字段名 变量名 必填 类型 示例值 描述
Key 床型ID 是 string
Desc 尺寸信息 是 string
BedCount 床型数量 是 int 大于0

示例

                    
{
    "ChannelKey": "web",
    "Method": "RoomType.UpdateOrgRoomType",
    "BizContent": "{\"OrgId\":2147483644,\"RoomTypeId\":\"777\",\"Capacity\":4,\"RoomArea\":18,\"Washroom\":1,
                                \"Window\":2,\"Description\":\"帅效果1\",\"SimpleRoomTypeName\":\"帅效2果\",
                                \"ImageUris\":\"dsfsdfs\",
                                \"BedTypes\":[{\"Key\":\"BunkBeds\",\"Name\":\"上下铺\",\"Desc\":\"上铺1.0x2.0米 下铺1.35x2.0米\",\"BedCount\":1},
                                {\"Key\":\"Large\",\"Name\":\"大床房\",\"Desc\":\"0.8x2.0米\",\"BedCount\":1}]}",
    "Sign": "F590542F7CBC8DC9815B7EAEB0221961",
    "SignType": "MD5",
    "Format": "json",
    "Charset": "utf-8",
    "Version": "1.0",
    "Timestamp": "2019-12-26 17:26:16"
}

返回结果

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

示例

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

3.查询可选房间的房间特征

RoomType.GetOrderAvailableRoomsAttributes

应用场景

查询订单可选房间的房间特征

请求参数

字段名 变量名 必填 类型 示例值 描述
OrgId 酒店Id 是 long 2147483644
OrderId 订单号 是 long 1056711985823745

示例

                    
                            {
                            "ChannelKey": "web",
                            "Method": "RoomType.GetOrderAvailableRoomsAttributes",
                            "BizContent": "{\"OrgId\":2147483644,\"OrderId\":1056711985823745}",
                            "Sign": "DF71DF3C8CBE1B1085DA964ADDC9ED57",
                            "SignType": "MD5",
                            "Format": "json",
                            "Charset": "utf-8",
                            "Version": "1.0",
                            "Timestamp": "2019-12-26 14:30:16"
                            }

返回结果

字段名 变量名 必填 类型 示例值 描述
RoomTypeId 房型ID 是 string DCF
RoomNo 房间号 是 string 8001
Status 房态 是 string VC
Attributes 房间特征 是 string 安静|无烟房|无窗

示例

                
                        {
                        "Code": 10000,
                        "Message": null,
                        "SubCode": null,
                        "SubMessage": null,
                        "Data": [
                        {
                        "RoomTypeId": "DR",
                        "RoomNo": "3002",
                        "Status": "VC",
                        "Attributes": "安静|无烟房|无窗"
                        },
                        {
                        "RoomTypeId": "DR",
                        "RoomNo": "3055",
                        "Status": "VC",
                        "Attributes": "无烟房|无窗"
                        }
                        ]
                        }

4.查询房型实时售卖情况

RoomType.GetRealTimeRentRateByRoomTypeId

应用场景

查询房型实时售卖情况（在住、预抵、预离、维修、出租率）

请求参数

字段名 变量名 必填 类型 示例值 描述
OrgId 酒店Id 是 long 492080278896642
RoomTypeId 房型编号 是 string BJ

示例

                        
                            {
                            "ChannelKey": "Hotel",
                            "Method": "RoomType.GetRealTimeRentRateByRoomTypeId",
                            "BizContent": "{\"OrgId\":492080278896642,\"RoomTypeId\":\"BJ\"}",
                            "Sign": "AC4ECE2FB85ABD76F45D2D4B247281BF",
                            "SignType": "MD5",
                            "Format": "json",
                            "Charset": "utf-8",
                            "Version": "1.0",
                            "Timestamp": "2021-10-19 19:23:01"
                            }

返回结果

字段名 变量名 必填 类型 示例值 描述
CheckinCount 在住数 是 int 0
ArriveCount 预抵数 是 int 0
DepartureCount 预离数 是 int 0
MaintainCount 维护数 是 int 0
RentRate 出租率 是 double 0.8234 小数保留4位

示例

                    
                        {
                        "Code": 10000,
                        "Message": null,
                        "SubCode": null,
                        "SubMessage": null,
                        "Data": {
                        "CheckinCount": 42,
                        "ArriveCount": 0,
                        "DepartureCount": 30,
                        "MaintainCount": 0,
                        "RentRate": 0.8367
                        }