PMS住宿设置

房型房间设置

获取房型列表

接口地址

POST /api/v1/pmsRoom/getRoomTypeList

请求参数

名称	类型	是否必需	示例	描述
pms_id	int	Y	2	pms-storeID

返回结果

名称	类型	描述
pms_id	int	pms-storeID
room_type_id	int	房型ID
name	string	房型名称
short_name	string	房型简称
price_type	int	门市开关类型 10不区分 20区分平日、周末
price	string	每日价格/平日价格
weekend_price	string	周末价格 price_type=20必填
room_count	int	房间数量
room_list	array	房间列表
room_list.*.room_id	int	房间ID
room_list.*.sort	int	排序值
room_list.*.room_name	string	房间名称
room_list.*.sub_rooms	array	子房间列表
room_list..sub_rooms..sub_room_no	string	子房间号

返回示例

json

{
    "error_code": 0,
    "description": "success",
    "error_msg": "success",
    "data": {
        "list": [
            {
                "pms_id": 2,
                "name": "日式简约双人大床房",
                "short_name": "大床房",
                "price_type": 10,
                "price": "100.00",
                "weekend_price": "0.00",
                "room_list": [
                    {
                        "room_id": 19,
                        "sort": 1,
                        "room_name": "101",
                        "sub_rooms": [
                            {
                                "sub_room_no": "A"
                            }
                        ]
                    },
                    {
                        "room_id": 20,
                        "sort": 2,
                        "room_name": "102",
                        "sub_rooms": [
                            {
                                "sub_room_no": "A"
                            }
                        ]
                    }
                ],
                "room_type_id": 3,
                "room_count": 0
            }
        ],
        "total": 1,
        "page_no": 1,
        "page_size": 10,
        "room_count_limit": 20,
        "room_count_used": 10
    }
}

创建房型

接口地址

POST /api/v1/pmsRoom/addRoomType

请求参数

名称	类型	是否必需	示例	描述
pms_id	int	Y	2	pms-storeID
name	string	Y	"日式简约双人大床房"	房型名称
short_name	string	Y	"大床房"	房型简称
price_type	string	Y	"10"	门市开关类型 10不区分 20区分平日、周末
price	string	Y	"100.00"	每日价格/平日价格
weekend_price	string	N	"120.00"	周末价格 price_type=20必填
room_list	array	Y	[]	房间列表
room_list.*.room_name	string	Y	"101"	房间名称

返回示例

json

{
    "error_code": 0,
    "error_msg": "",
    "description": "",
    "data": {}
}

更新房型

接口地址

POST /api/v1/pmsRoom/updateRoomType

请求参数

名称	类型	是否必需	示例	描述
room_type_id	int	Y	3	房型ID
name	string	Y	"日式简约双人大床房"	房型名称
short_name	string	Y	"大床房"	房型简称
price_type	int	Y	10	门市开关类型 10不区分 20区分平日、周末
price	string	Y	"100.00"	每日价格/平日价格
weekend_price	string	N	"120.00"	周末价格 price_type=20必填
room_list	array	Y	[]	房间列表
room_list.*.room_id	int	N	19	房间ID 新增房间不需要携带
room_list.*.room_name	string	Y	"101"	房间名称

返回示例

json

{
    "error_code": 0,
    "error_msg": "",
    "description": "",
    "data": {}
}

删除房型

接口地址

POST /api/v1/pmsRoom/deleteRoomType

请求参数

名称	类型	是否必需	示例	描述
room_type_id	int	Y	3	房型ID

返回示例

json

{
    "error_code": 0,
    "error_msg": "",
    "description": "",
    "data": {}
}

更新房间

接口地址

POST /api/v1/pmsRoom/updateRoom

请求参数

名称	类型	是否必需	示例	描述
room_id	int	Y	19	房间ID
room_name	string	N	"101"	房间名称
sort	int	N	1	排序值
is_dirty	int	N	2	是否脏房 2否 1是

返回示例

json

{
    "error_code": 0,
    "error_msg": "",
    "description": "",
    "data": {}
}

更新房型排序

接口地址

POST /api/v1/pmsRoom/updateRoomTypeSort

请求参数

名称	类型	是否必需	示例	描述
room_type_list	array	Y	[]	房型列表
room_type_list.*.room_type_id	int	Y	3	房型ID
room_type_list.*.sort	int	Y	1	排序值

返回示例

json

{
    "error_code": 0,
    "error_msg": "",
    "description": "",
    "data": {}
}

获取房型Select列表

接口地址

POST /api/v1/pmsRoom/getRoomTypeSelect

请求参数

名称	类型	是否必需	示例	描述
pms_id	int	Y	2	pms-storeID
types	array	N	[1, 2]	房型类型 1:房型 2：包栋例子[1,2] 不传默认是为：1

返回结果

名称	类型	描述
room_type_id	int	房型ID
name	string	房型名称
sort	int	排序值
form_type	int	房型类型 1:房型 2：包栋
price	string	门市价格

返回示例

json

{
    "error_code": 0,
    "description": "success",
    "error_msg": "success",
    "data": [
        {
            "room_type_id": 3,
            "name": "日式简约双人大床房",
            "sort": 1,
            "form_type": 1,
            "price": "100.00"
        },
        {
            "room_type_id": 10,
            "name": "日式简约双人大床房22",
            "sort": 1,
            "form_type": 1,
            "price": "100.00"
        }
    ]
}

下载房型导入模板

接口地址

POST /api/v1/pmsRoom/downloadTemplate

请求参数

名称	类型	是否必需	示例	描述
pms_id	int	Y	2	pms-storeID

返回示例

json

{
    "error_code": 0,
    "error_msg": "",
    "description": "",
    "data": {
        "url": "http://example.com/storage/templates/导入房型模板.xlsx"
    }
}

导入房型

接口地址

POST /api/v1/pmsRoom/importRoomType

请求参数

名称	类型	是否必需	示例	描述
pms_id	int	Y	2	pms-storeID
file	file	Y	-	Excel文件，格式如下：房型名称\|简称\|价格\|周末价格\|排序\|房间号(多个用逗号分隔) 标准双人房\|双人房\|140\|140\|1\|101,102,103

返回示例

json

{
    "error_code": 0,
    "error_msg": "",
    "description": "",
    "data": {
        "success_count": 2,
        "error_rows": [
            {
                "row": 2,
                "error": "房型名称、简称和价格为必填项"
            }
        ]
    }
}

错误说明

错误信息	描述
房型名称、简称和价格为必填项	Excel文件中这些字段不能为空
房型名称已存在	同一个 PMS 下不能有重复的房型名称

更新房间排序

接口地址

POST /api/v1/pmsRoom/updateRoomSort

请求参数

名称	类型	是否必需	示例	描述
room_list	array	Y	[]	房间列表
room_list.*.room_id	int	Y	19	房间ID
room_list.*.sort	int	Y	1	排序值

返回示例

json

{
    "error_code": 0,
    "error_msg": "",
    "description": "",
    "data": {}
}

钟点房设置

获取可选房型列表

接口地址

POST /api/v1/pmsRoom/getRoomTypeSelectList

请求参数

名称	类型	是否必需	示例	描述
pms_id	int	Y	2	pms-storeID
search_str	string	N	"关键字"	搜索关键字
hour_id	int	N	1	钟点房ID 编辑时可填

返回结果

名称	类型	描述
room_type_id	int	房型ID
name	string	房型名称

返回示例

json

{
    "error_code": 0,
    "description": "success",
    "error_msg": "success",
    "data": [
        {
            "room_type_id": 3,
            "name": "日式简约双人大床房"
        }
    ]
}

添加钟点房

接口地址

POST /api/v1/pmsRoom/addHourRoom

请求参数

名称	类型	是否必需	示例	描述
room_type_id	int	Y	3	房型ID
start_hh	int	Y	2	起步时长1~24
start_price	string	Y	"100.00"	起步价格
unit_hh	int	Y	1	单位时长1~24
unit_price	string	Y	"50.00"	单位价格
max_hh	int	Y	24	最大时长1~24

返回示例

json

{
    "error_code": 0,
    "error_msg": "",
    "description": "",
    "data": {}
}

更新钟点房

接口地址

POST /api/v1/pmsRoom/updateHourRoom

请求参数

名称	类型	是否必需	示例	描述
hour_id	int	Y	1	钟点房ID
room_type_id	int	Y	3	房型ID
start_hh	int	Y	2	起步时长1~24
start_price	string	Y	"100.00"	起步价格
unit_hh	int	Y	1	单位时长1~24
unit_price	string	Y	"50.00"	单位价格
max_hh	int	Y	24	最大时长1~24

返回示例

json

{
    "error_code": 0,
    "error_msg": "",
    "description": "",
    "data": {}
}

删除钟点房

接口地址

POST /api/v1/pmsRoom/deleteHourRoom

请求参数

名称	类型	是否必需	示例	描述
hour_id	int	Y	1	钟点房ID

返回示例

json

{
    "error_code": 0,
    "error_msg": "",
    "description": "",
    "data": {}
}

获取钟点房列表

接口地址

POST /api/v1/pmsRoom/getHourRoomList

请求参数

名称	类型	是否必需	示例	描述
pms_id	int	Y	2	pms-storeID
page_no	int	N	1	页码
page_size	int	N	10	每页数量
search_str	string	N	"关键字"	搜索关键字

返回结果

名称	类型	描述
pms_id	int	pms-storeID
room_type_id	int	房型ID
room_type_name	string	房型名称
start_hh	int	起步时长
start_price	string	起步价格
unit_hh	int	单位时长
unit_price	string	单位价格
max_hh	int	最大时长
hour_id	int	钟点房ID

返回示例

json

{
    "error_code": 0,
    "description": "success",
    "error_msg": "success",
    "data": {
        "list": [
            {
                "pms_id": 2,
                "room_type_id": 6,
                "start_hh": 10,
                "start_price": "100.00",
                "unit_hh": 2,
                "unit_price": "50.00",
                "max_hh": 24,
                "hour_id": 3,
                "room_type_name": "日式简约双人大床房1"
            }
        ],
        "total": 1,
        "page_no": 1,
        "page_size": 10
    }
}

包栋设置

添加包栋

接口地址

POST /api/v1/pmsBuilding/add

请求参数

名称	类型	是否必需	示例	描述
pms_id	int	Y	2	pms-storeID
name	string	Y	"包栋名称"	包栋名称
short_name	string	Y	"包栋简称"	包栋简称
price_type	string	Y	"10"	门市开关类型 10不区分 20区分平日、周末
price	string	Y	"100.00"	每日价格/平日价格
weekend_price	string	N	"120.00"	周末价格 price_type=20必填
room_list	array	Y	[]	房型列表
room_list.*.room_id	int	Y	19	房间ID
room_list.*.ratio	int	Y	50	房间价格比例 1-99

返回示例

json

{
    "error_code": 0,
    "error_msg": "",
    "description": "",
    "data": {}
}

更新包栋

接口地址

POST /api/v1/pmsBuilding/update

请求参数

名称	类型	是否必需	示例	描述
building_id	int	Y	1	包栋ID
name	string	Y	"包栋名称"	包栋名称
short_name	string	Y	"包栋简称"	包栋简称
price_type	string	Y	"10"	门市开关类型 10不区分 20区分平日、周末
price	string	Y	"100.00"	每日价格/平日价格
weekend_price	string	N	"120.00"	周末价格 price_type=20必填
room_list	array	Y	[]	房型列表
room_list.*.room_id	int	Y	19	房间ID
room_list.*.ratio	int	Y	50	房间价格比例 1-99

返回示例

json

{
    "error_code": 0,
    "error_msg": "",
    "description": "",
    "data": {}
}

删除包栋

接口地址

POST /api/v1/pmsBuilding/delete

请求参数

名称	类型	是否必需	示例	描述
building_id	int	Y	1	包栋ID

返回示例

json

{
    "error_code": 0,
    "error_msg": "",
    "description": "",
    "data": {}
}

获取包栋列表

接口地址

POST /api/v1/pmsBuilding/list

请求参数

名称	类型	是否必需	示例	描述
pms_id	int	Y	2	pms-storeID
page_no	int	N	1	页码
page_size	int	N	10	每页数量
search_str	string	N	"关键字"	搜索关键字

返回结果

名称	类型	描述
pms_id	int	pms-storeID
name	string	包栋名称
short_name	string	包栋简称
price_type	string	门市开关类型 10不区分 20区分平日、周末
price	string	每日价格/平日价格
weekend_price	string	周末价格 price_type=20必填
room_list	array	房型列表
room_list.*.room_id	int	房间ID
room_list.*.ratio	int	房间价格比例 1-99
room_list.*.room_name	string	房间名称

返回示例

json

{
    "error_code": 0,
    "description": "success",
    "error_msg": "success",
    "data": {
        "list": [
            {
                "pms_id": 2,
                "name": "包栋名称",
                "short_name": "包栋简称",
                "price_type": 10,
                "price": "100.00",
                "weekend_price": "0.00",
                "created_at": "2025-02-18T11:59:21.000000Z",
                "updated_at": "2025-02-18T11:59:21.000000Z",
                "building_id": 1,
                "building_list": [
                    {
                        "room_id": 19,
                        "ratio": 1,
                        "room_name": "日式简约双人大床房-101"
                    }
                ]
            }
        ],
        "total": 1,
        "page_no": 1,
        "page_size": 10
    }
}

早餐设置

添加早餐

接口地址

POST /api/v1/pmsBreakfast/add

请求参数

名称	类型	是否必需	示例	描述
pms_id	int	Y	2	pms-storeID
name	string	Y	"早餐名称"	早餐名称
price_type	int	Y	10	计价方式 10：单独计价 20：房费包含
price	string	Y	"100.00"	价格
business_type	int	Y	10	营业归属 10：住宿 20：餐饮
charge_mode	int	N	20	抛账模式 10：扣除前一天房费 20：扣除当天房费
restaurant_id	int	N	1	归宿餐厅ID business_type=20必填

返回示例

json

{
    "error_code": 0,
    "error_msg": "",
    "description": "",
    "data": {}
}

更新早餐

接口地址

POST /api/v1/pmsBreakfast/update

请求参数

名称	类型	是否必需	示例	描述
breakfast_id	int	Y	1	早餐ID
name	string	N	"早餐名称"	早餐名称
price_type	int	N	10	计价方式 10：单独计价 20：房费包含
price	string	N	"100.00"	价格
business_type	int	N	10	营业归属 10：住宿 20：餐饮
charge_mode	int	N	20	抛账模式 10：扣除前一天房费 20：扣除当天房费
restaurant_id	int	N	1	归宿餐厅ID business_type=20必填
status	int	N	1	状态 1：启用 2：禁用

返回示例

json

{
    "error_code": 0,
    "error_msg": "",
    "description": "",
    "data": {}
}

获取早餐列表

接口地址

POST /api/v1/pmsBreakfast/list

请求参数

名称	类型	是否必需	示例	描述
pms_id	int	Y	2	pms-storeID
page_no	int	N	1	页码
page_size	int	N	10	每页数量
search_str	string	N	"关键字"	搜索关键字

返回结果

名称	类型	描述
pms_id	int	pms-storeID
name	string	早餐名称
price_type	int	计价方式 10：单独计价 20：房费包含
price	string	价格
business_type	int	营业归属 10：住宿 20：餐饮
charge_mode	int	抛账模式 10：扣除前一天房费 20：扣除当天房费
restaurant_id	int	归宿餐厅ID business_type=20必填
restaurant_name	string	归宿餐厅名称
breakfast_id	int	早餐ID
status	int	状态 1：启用 2：禁用

返回示例

json

{
    "error_code": 0,
    "description": "success",
    "error_msg": "success",
    "data": {
        "list": [
            {
                "pms_id": 2,
                "name": "早餐名称",
                "price_type": 10,
                "charge_mode": 20,
                "price": "100.00",
                "business_type": 10,
                "restaurant_id": 0,
                "status": 1,
                "breakfast_id": 1
            }
        ],
        "total": 1,
        "page_no": 1,
        "page_size": 10
    }
}

删除早餐

接口地址

POST /api/v1/pmsBreakfast/delete

请求参数

名称	类型	是否必需	示例	描述
breakfast_id	int	Y	1	早餐ID

返回示例

json

{
    "error_code": 0,
    "description": "success",
    "error_msg": "success",
    "data": {}
}

消费项设置

添加消费项分组

接口地址

POST /api/v1/pmsConsume/addGroup

请求参数

名称	类型	是否必需	示例	描述
pms_id	int	Y	2	pms-storeID
name	string	Y	"分组名称"	分组名称

返回示例

json

{
    "error_code": 0,
    "error_msg": "",
    "description": "",
    "data": {}
}

更新消费项分组

接口地址

POST /api/v1/pmsConsume/updateGroup

请求参数

名称	类型	是否必需	示例	描述
consume_group_id	int	Y	1	分组ID
name	string	N	"分组名称"	分组名称
sort	int	N	1	排序值

返回示例

json

{
    "error_code": 0,
    "error_msg": "",
    "description": "",
    "data": {}
}

删除消费项分组

接口地址

POST /api/v1/pmsConsume/deleteGroup

请求参数

名称	类型	是否必需	示例	描述
consume_group_id	int	Y	1	分组ID

返回示例

json

{
    "error_code": 0,
    "error_msg": "",
    "description": "",
    "data": {}
}

更新消费排序

接口地址

POST /api/v1/pmsConsume/updateConsumeSort

请求参数

名称	类型	是否必需	示例	描述
consume_list	array	Y	[]	消费项列表
consume_list.*.consume_id	int	Y	1	消费项ID
consume_list.*.sort	int	Y	1	排序值

返回示例

json

{
    "error_code": 0,
    "error_msg": "",
    "description": "",
    "data": {}
}

获取消费项分组列表

接口地址

POST /api/v1/pmsConsume/getGroupList

请求参数

名称	类型	是否必需	示例	描述
pms_id	int	Y	2	pms-storeID

返回结果

名称	类型	描述
pms_id	int	pms-storeID
consume_group_id	int	分组ID
name	string	分组名称
sort	int	排序值
is_default	int	是否默认 1是 2否

返回示例

json

{
    "error_code": 0,
    "description": "success",
    "error_msg": "success",
    "data": [
        {
            "pms_id": "2",
            "name": "其他",
            "sort": 0,
            "is_default": 1,
            "consume_group_id": 1
        },
        {
            "pms_id": "2",
            "name": "支出",
            "sort": 0,
            "is_default": 1,
            "consume_group_id": 2
        }
    ]
}

获取消费类别

接口地址

POST /api/v1/pmsConsume/getCategory

请求参数

名称	类型	是否必需	示例	描述
pms_id	int	Y	2	pmsId
search_str	string	N	"关键字"	搜索关键字

返回结果

名称	类型	描述
consume_group_id	int	分组ID
name	string	分组名称
consume_list	array	消费项列表
consume_list.*.consume_id	int	消费项ID
consume_list.*.name	string	消费项名称
consume_list.*.price	string	价格

返回示例

json

{
    "error_code": 0,
    "description": "success",
    "error_msg": "success",
    "data": [
        {
            "consume_group_id": 1,
            "name": "其他",
            "consume_list": []
        },
        {
            "consume_group_id": 2,
            "name": "支出",
            "consume_list": [
                {
                    "consume_id": 2,
                    "name": "酒水",
                    "price": "100.00"
                }
            ]
        }
    ]
}

更新消费分组排序

接口地址

POST /api/v1/pmsConsume/updateConsumeGroupSort

请求参数

名称	类型	是否必需	示例	描述
consume_group_list	array	Y	[]	消费分组列表
consume_group_list.*.consume_group_id	int	Y	1	分组ID
consume_group_list.*.sort	int	Y	1	排序值

返回示例

json

{
    "error_code": 0,
    "error_msg": "",
    "description": "",
    "data": {}
}

添加消费项

接口地址

POST /api/v1/pmsConsume/addConsume

请求参数

名称	类型	是否必需	示例	描述
pms_id	int	Y	2	pms-storeID
group_id	int	Y	1	分组ID
name	string	Y	"消费项名称"	消费项名称
price	string	Y	"100.00"	价格
owner_type	int	Y	10	业主归属 10：住宿 20：餐饮 30：商超
restaurant_id	int	N	1	归宿餐厅ID owner_type=20必填
supermarket_id	int	N	1	归宿商超ID owner_type=30必填

返回示例

json

{
    "error_code": 0,
    "error_msg": "",
    "description": "",
    "data": {}
}

更新消费项

接口地址

POST /api/v1/pmsConsume/updateConsume

请求参数

名称	类型	是否必需	示例	描述
consume_id	int	Y	1	消费项ID
group_id	int	N	1	分组ID
name	string	N	"消费项名称"	消费项名称
price	string	N	"100.00"	价格
owner_type	int	N	10	业主归属 10：住宿 20：餐饮 30：商超
restaurant_id	int	N	1	归宿餐厅ID owner_type=20必填
supermarket_id	int	N	1	归宿商超ID owner_type=30必填
status	int	N	1	状态 1：启用 2：禁用

返回示例

json

{
    "error_code": 0,
    "error_msg": "",
    "description": "",
    "data": {}
}

删除消费项

接口地址

POST /api/v1/pmsConsume/deleteConsume

请求参数

名称	类型	是否必需	示例	描述
consume_id	int	Y	1	消费项ID

返回示例

json

{
    "error_code": 0,
    "error_msg": "",
    "description": "",
    "data": {}
}

获取消费项列表

接口地址

POST /api/v1/pmsConsume/getConsumeList

请求参数

名称	类型	是否必需	示例	描述
pms_id	int	Y	2	pms-storeID
page_no	int	N	1	页码
page_size	int	N	10	每页数量
search_str	string	N	"关键字"	搜索关键字

返回结果

名称	类型	描述
pms_id	int	pms-storeID
consume_id	int	消费项ID
group_id	int	分组ID
name	string	消费项名称
price	string	价格
owner_type	int	业主归属 10：住宿 20：餐饮 30：商超
restaurant_id	int	归宿餐厅ID owner_type=20必填
supermarket_id	int	归宿商超ID owner_type=30必填
status	int	状态 1：启用 2：禁用

返回示例

json

{
    "error_code": 0,
    "description": "success",
    "error_msg": "success",
    "data": {
        "list": [
            {
                "pms_id": "2",
                "group_id": 2,
                "name": "酒水",
                "price": "100.00",
                "owner_type": 10,
                "restaurant_id": "0",
                "supermarket_id": "0",
                "status": 1,
                "group_name": "支出",
                "consume_id": 2
            }
        ],
        "total": 1,
        "page_no": 1,
        "page_size": 10
    }
}

房价分组设置

更新房间分组设置

接口地址

POST /api/v1/pmsGroup/update

请求参数

名称	类型	是否必需	示例	描述
pms_id	int	Y	2	pms-storeID
groupList	array	Y	[]	分组列表
groupList.*.group_id	int	N/Y	1	分组ID 有就填，没就不要填，新增分组是没有此参数的，只在编辑已有的分组中存在
groupList.*.name	string	Y	"分组名称"	分组名称
groupList.*.room_list	array	Y	[]	房型列表
groupList..room_list..room_id	int	Y	19	房价ID
groupList..room_list..sort	int	Y	1	排序值

返回示例

json

{
    "error_code": 0,
    "error_msg": "",
    "description": "",
    "data": {}
}

获取房间分组数据

接口地址

POST /api/v1/pmsGroup/getGroupData

请求参数

名称	类型	是否必需	示例	描述
pms_id	int	Y	2	pms-storeID

返回结果

名称	类型	描述
group_list	array	分组列表
group_list.*.group_id	int	分组ID
group_list.*.group_name	string	分组名称
group_list.*.room_list	array	房间列表
group_list..room_list..room_id	int	房间ID
group_list..room_list..room_name	string	房间名称
group_list..room_list..sort	int	排序值
group_list..room_list..room_type_name	string	房型名称
default_group_room_list	array	未分组列表
default_group_room_list.*.room_id	int	房间ID
default_group_room_list.*.room_type_name	string	房型名称
default_group_room_list.*.room_name	string	房间名称

返回示例

json

{
    "error_code": 0,
    "description": "success",
    "error_msg": "success",
    "data": {
        "group_list": [
            {
                "group_id": 34,
                "group_name": "分组1",
                "room_list": []
            },
            {
                "group_id": 35,
                "group_name": "分组2",
                "room_list": []
            },
            {
                "group_id": 36,
                "group_name": "分组3",
                "room_list": [
                    {
                        "room_id": 20,
                        "room_type_name": "日式简约双人大床房",
                        "room_name": "102",
                        "sort": 1
                    }
                ]
            }
        ],
        "default_group_list": [
            {
                "room_id": 19,
                "room_type_name": "日式简约双人大床房",
                "room_name": "101"
            },
            {
                "room_id": 21,
                "room_type_name": "日式简约双人大床房1",
                "room_name": "1011"
            }
        ]
    }
}

获取所有分组Select列表

接口地址

POST /api/v1/pmsGroup/getGroupSelectList

请求参数

名称	类型	是否必需	示例	描述
pms_id	int	Y	2	pms-storeID

返回结果

名称	类型	描述
group_id	int	分组ID
group_name	string	分组名称
sort	int	排序值

返回示例

json

{
    "error_code": 0,
    "description": "success",
    "error_msg": "success",
    "data": [
        {
            "group_id": 1,
            "group_name": "未分组房间",
            "sort": 0
        },
        {
            "group_id": 2,
            "group_name": "参数",
            "sort": 0
        }
    ]
}

更新分组排序

接口地址

POST /api/v1/pmsGroup/updateGroupSort

请求参数

名称	类型	是否必需	示例	描述
group_list	array	Y	[]	分组列表
group_list.*.group_id	int	Y	1	分组ID
group_list.*.sort	int	Y	1	排序值

返回示例

json

{
    "error_code": 0,
    "description": "success",
    "error_msg": "success",
    "data": {}
}

订单盒子设置

添加订单盒子标签

接口地址

POST /api/v1/pmsRoomOrder/addOrderBoxTag

请求参数

名称	类型	是否必需	示例	描述
pms_id	int	Y	2	pms-storeID
name	string	Y	"标签名称"	标签名称

返回示例

json

{
    "error_code": 0,
    "description": "success",
    "error_msg": "success",
    "data": {}
}

更新订单盒子标签

接口地址

POST /api/v1/pmsRoomOrder/updateOrderBoxTag

请求参数

名称	类型	是否必需	示例	描述
tag_id	int	Y	1	标签ID
name	string	N	"标签名称"	标签名称注意默认标签不允许修改
sort	int	N	1	排序值

返回示例

json

{
    "error_code": 0,
    "description": "success",
    "error_msg": "success",
    "data": {}
}

删除订单盒子标签

接口地址

POST /api/v1/pmsRoomOrder/deleteOrderBoxTag

请求参数

名称	类型	是否必需	示例	描述
tag_id	int	Y	1	标签ID

返回示例

json

{
    "error_code": 0,
    "description": "success",
    "error_msg": "success",
    "data": {}
}

获取订单盒子标签select列表

接口地址

POST /api/v1/pmsRoomOrder/getOrderBoxTagSelectList

请求参数

名称	类型	是否必需	示例	描述
pms_id	int	Y	2	pms-storeID

返回结果

名称	类型	描述
pms_id	int	pms-storeID
name	string	标签名称
is_default	int	是否默认 1是 2否
sort	int	排序值
tag_id	int	标签ID

返回示例

json

{
    "error_code": 0,
    "description": "success",
    "error_msg": "success",
    "data": [
        {
            "pms_id": 2,
            "name": "冲突",
            "is_default": 1,
            "sort": 0,
            "tag_id": 1
        },
        {
            "pms_id": 2,
            "name": "刷单",
            "is_default": 1,
            "sort": 0,
            "tag_id": 2
        }
    ]
}

门锁设置

添加设备（由APP对接）

接口地址

POST /api/v1/pmsDevice/addDevice

请求参数

名称	类型	是否必需	示例	描述
pms_id	int	Y	2	pms-storeID
device_no	string	Y/N	"TMD5991"	设备编号 lock_info.lock_type===10必填
type	int	Y	10	设备类型 10：智能锁
lock_info	object	Y/N	{}	锁信息 type===10必填写
lock_info.lock_scene_type	int	Y	1	锁场景类型 1: PMS门锁 2: 分区门锁，3：楼栋门锁，4：楼层门锁，5：房间门锁，6：子房间门锁
lock_info.lock_type	int	Y	10	锁类型 10：密码锁 20：门卡锁
lock_info.has_gateway	int	Y/N	1	是否有网关 1：有 2：无 lock_type===10必填
lock_info.area_id	int	N	1	分区ID lock_scene_type===2: 分区门锁，3：楼栋门锁，4：楼层门锁，5：房间门锁，6：子房间门锁必填
lock_info.building_id	int	N	6	楼栋ID lock_scene_type===3：楼栋门锁，4：楼层门锁，5：房间门锁，6：子房间门锁必填
lock_info.floor_id	int	N	91	楼层ID lock_scene_type===4：楼层门锁，5：房间门锁，6：子房间门锁必填
lock_info.room_id	int	N	19	房间ID lock_scene_type===5：房间门锁，6：子房间门锁必填
lock_info.sub_room_no	string	N	"A"	子房间号 lock_scene_type===6：子房间门锁必填

返回结果

名称	类型	描述
device_id	int	设备ID
device_no	string	设备编号

返回示例

json

{
    "error_code": 0,
    "description": "success",
    "error_msg": "success",
    "data": {
        "device_id": 1,
        "device_no": ""
    }
}

删除设备（由APP接入）

接口地址

POST /api/v1/pmsDevice/deleteDevice

请求参数

名称	类型	是否必需	示例	描述
device_id	int	Y	1	设备ID

返回示例

json

{
    "error_code": 0,
    "description": "success",
    "error_msg": "success",
    "data": {}
}

获取设备列表（web接入）

接口地址

POST /api/v1/pmsDevice/getDeviceList

请求参数

名称	类型	是否必需	示例	描述
pms_id	int	Y	2	pms-storeID
type	int	N	10	设备类型 10：智能锁
lock_type	int	N	10	锁类型 10：密码锁 20：门卡锁需前置type===10参数配合查询
page_no	int	N	1	页码
page_size	int	N	10	每页数量
search_str	string	N	"关键字"	搜索关键字

返回结果

名称	类型	描述
device_id	int	设备ID
device_no	string	设备编号
device_name	string	设备名称
type	int	设备类型 10：智能锁
type_name	string	设备类型名称
lock_info	object	锁信息
lock_info.room_full_name	string	房间全称
lock_info.lock_type	int	锁类型 10：密码锁 20：门卡锁
lock_info.has_gateway	int	是否有网关 1：有 2：无

返回示例

json

{
    "error_code": 0,
    "description": "success",
    "error_msg": "success",
    "data": {
        "list": [
            {
                "device_id": 1,
                "device_no": "TMD5991",
                "device_name": "老房-1103",
                "type": 10,
                "type_name": "智能锁",
                "lock_info": {
                    "room_full_name": "老房-1103",
                    "lock_type": 20,
                    "has_gateway": 2
                }
            }
        ],
        "total": 1,
        "page_no": 1,
        "page_size": 10
    }
}

更新门锁

接口地址

POST /api/v1/pmsDevice/updateDevice

请求参数

名称	类型	是否必需	示例	描述
device_id	int	Y	1	设备ID
device_no	string	N	"TMD5991"	设备编号
lock_info	object	N	{}	锁信息
lock_info.has_gateway	int	N	1	是否有网关 1：有 2：无

返回示例

json

{
    "error_code": 0,
    "description": "success",
    "error_msg": "success",
    "data": {}
}

生成关联场景

接口地址

POST /api/v1/pmsDevice/generateScene

请求参数

名称	类型	是否必需	示例	描述
pms_id	int	Y	2	pms-storeID
type	int	Y	1	获取关联层级 1：分区 2：分区至楼栋 3：分区至楼栋至楼层

返回结果

名称	类型	描述
value	int	关联ID
label	string	关联名称
children	array	子级列表

返回示例

json

{
    "error_code": 0,
    "description": "success",
    "error_msg": "success",
    "data": [
        {
            "value": 2,
            "label": "默认分区",
            "children": [
                {
                    "value": 6,
                    "label": "A栋",
                    "children": [
                        {
                            "value": 91,
                            "label": "001"
                        }
                    ]
                }
            ]
        }
    ]
}

楼栋设置

添加楼栋

接口地址

POST /api/v1/pmsBuilding/addBuilding

请求参数

名称	类型	是否必需	示例	描述
pms_id	int	Y	2	pms-storeID
area_id	int	Y	1	分区ID
building_name	string	Y	"A栋"	楼栋名称
floor_start_no	string	Y	"001"	楼层初始号
floor_num	int	Y	6	楼层总数量

返回结果

名称	类型	描述
building_id	int	楼栋ID

返回示例

json

{
    "error_code": 0,
    "description": "success",
    "error_msg": "success",
    "data": {
        "building_id": 1
    }
}

更新楼栋

接口地址

POST /api/v1/pmsBuilding/updateBuilding

请求参数

名称	类型	是否必需	示例	描述
building_id	int	Y	1	楼栋ID
area_id	int	N	1	分区ID
building_name	string	N	"A栋"	楼栋名称
floor_list	array	N	[]	楼层列表
floor_list.*.floor_id	int	N/Y	91	楼层ID 存在即更新不存在即新添加
floor_list.*.floor_no	string	Y	"001"	楼层号仅限于数字

返回结果

名称	类型	描述
building_id	int	楼栋ID

返回示例

json

{
    "error_code": 0,
    "description": "success",
    "error_msg": "success",
    "data": {
        "building_id": 1
    }
}

获取楼栋列表

接口地址

POST /api/v1/pmsBuilding/listBuilding

请求参数

名称	类型	是否必需	示例	描述
pms_id	int	Y	2	pms-storeID
page_no	int	N	1	页码
page_size	int	N	10	每页数量

返回结果

名称	类型	描述
building_id	int	楼栋ID
building_name	string	楼栋名称
lock_info	object	锁信息
lock_info.lock_id	int	锁lockId
lock_info.device_no	string	锁编号
area_id	int	分区ID
area_name	string	分区名称
floor_list	array	楼层列表
floor_list.*.floor_id	int	楼层ID
floor_list.*.floor_no	string	楼层号
floor_list.*.lock_info	object	锁信息
floor_list.*.lock_info.lock_id	int	锁lockId
floor_list.*.lock_info.device_no	string	锁编号

返回示例

json

{
    "error_code": 0,
    "description": "success",
    "error_msg": "success",
    "data": {
        "list": [
            {
                "building_name": "B栋",
                "building_id": 5,
                "area_id": 1,
                "area_name": "宝安区",
                "lock_info": {
                    "lock_id": 123,
                    "device_no": "ABC123"
                },
                "floor_list": [
                    {
                        "floor_id": 85,
                        "floor_no": "001",
                        "lock_info": {
                            "lock_id": 456,
                            "device_no": "DEF456"
                        }
                    }
                ]
            }
        ],
        "total": 1,
        "page_no": 1,
        "page_size": 10
    }
}

删除楼栋

接口地址

POST /api/v1/pmsBuilding/deleteBuilding

请求参数

名称	类型	是否必需	示例	描述
building_id	int	Y	1	楼栋ID

返回示例

json

{
    "error_code": 0,
    "description": "success",
    "error_msg": "success",
    "data": {}
}

分区设置

添加分区

接口地址

POST /api/v1/pmsArea/add

请求参数

名称	类型	是否必需	示例	描述
pms_id	int	Y	2	pms-storeID
area_name	string	Y	"测试分区"	分区名称

返回结果

名称	类型	描述
area_id	int	分区ID
area_name	string	分区名称

返回示例

json

{
    "error_code": 0,
    "description": "success",
    "error_msg": "success",
    "data": {
        "area_id": 1,
        "area_name": "测试分区"
    }
}

更新分区

接口地址

POST /api/v1/pmsArea/update

请求参数

名称	类型	是否必需	示例	描述
area_id	int	Y	1	分区ID
area_name	string	Y	"测试分区修改"	分区名称

返回结果

名称	类型	描述
area_id	int	分区ID
area_name	string	分区名称

返回示例

json

{
    "error_code": 0,
    "description": "success",
    "error_msg": "success",
    "data": {
        "area_id": 1,
        "area_name": "测试分区修改"
    }
}

获取全部分区

接口地址

POST /api/v1/pmsArea/getAllArea

请求参数

名称	类型	是否必需	示例	描述
pms_id	int	Y	2	pms-storeID

返回结果

名称	类型	描述
area_id	int	分区ID
area_name	string	分区名称
buildings_count	int	楼栋数量
default	int	是否默认 1是 2否
lock_info	object	锁信息
lock_info.lock_id	int	锁lockId
lock_info.device_no	string	锁编号

返回示例

json

{
    "error_code": 0,
    "description": "success",
    "error_msg": "success",
    "data": {
        "list": [
            {
                "area_id": 2,
                "area_name": "默认分区",
                "buildings_count": 2,
                "default": 1,
                "lock_info": {
                    "lock_id": 1,
                    "device_no": "lock001"
                }
            }
        ]
    }
}

删除分区

接口地址

POST /api/v1/pmsArea/delete

请求参数

名称	类型	是否必需	示例	描述
area_id	int	Y	1	分区ID

返回示例

json

{
    "error_code": 0,
    "description": "success",
    "error_msg": "success",
    "data": {}
}

房间设置

关联房间到楼层

接口地址

POST /api/v1/pmsRoom/linkRoomToFloor

请求参数

名称	类型	是否必需	示例	描述
pms_id	int	Y	2	pms-storeID
floor_id	int	Y	91	楼层ID
room_id	int	Y	19	房间ID
child_room_no	string	N	"A"	子房间号可传 A~Z

返回示例

json

{
    "error_code": 0,
    "description": "success",
    "error_msg": "success",
    "data": {}
}

删除房间关联

接口地址

POST /api/v1/pmsRoom/deleteRoomLocation

请求参数

名称	类型	是否必需	示例	描述
location_id	int	Y	1	关联ID

返回示例

json

{
    "error_code": 0,
    "description": "success",
    "error_msg": "success",
    "data": {}
}

获取房间关联列表

接口地址

POST /api/v1/pmsRoom/getRoomLocationList

请求参数

名称	类型	是否必需	示例	描述
pms_id	int	Y	2	pms-storeID
building_id	int	N	6	楼栋ID
floor_id	int	N	91	楼层ID
room_id	int	N	19	房间ID
search_str	string	N	"关键字"	搜索关键字
page_no	int	N	1	页码
page_size	int	N	10	每页数量
linked_status	int	N	0	锁关联状态 0：全部 1：已关联 2：未关联

返回结果

名称	类型	描述
location_id	int	关联ID
room_id	int	房间ID
room_name	string	房间名称
room_type_name	string	房型类型名称
area_id	int	分区ID
area_name	string	分区名称
full_room_name	string	房间全称
building_id	int	楼栋ID
building_name	string	楼栋名称
floor_id	int	楼层ID
floor_name	string	楼层名称
linked_status	int	关联状态 1：已关联 2：未关联
lock_info	object	锁信息
lock_info.lock_id	int	锁lockId
lock_info.device_no	string	锁编号
sub_room_locations	array	子房间列表
sub_room_locations.*.sub_room_id	int	子房间ID
sub_room_locations.*.sub_room_no	string	子房间号
sub_room_locations.*.lock_info	object	锁信息
sub_room_locations.*.lock_info.lock_id	int	锁lockId
sub_room_locations.*.lock_info.device_no	string	锁编号

返回示例

json

{
    "error_code": 0,
    "description": "success",
    "error_msg": "success",
    "data": {
        "list": [
            {
                "location_id": 2,
                "room_id": 33,
                "room_name": "1102",
                "room_type_name": "单间",
                "area_id": 1,
                "area_name": "宝安区",
                "full_room_name": "老房-1102",
                "building_id": 6,
                "building_name": "A栋",
                "floor_id": 91,
                "floor_name": "001",
                "linked_status": 2,
                "sub_room_locations": [
                    {
                        "sub_room_id": 1,
                        "sub_room_no": "A",
                        "lock_info": {
                            "lock_id": 123,
                            "device_no": "ABC123"
                        }
                    }
                ]
            }
        ],
        "total": 2,
        "page_no": 1,
        "page_size": 10
    }
}

获取指定房间下的子房间列表

接口地址

POST /api/v1/pmsRoom/getRoomChildrenList

请求参数

名称	类型	是否必需	示例	描述
pms_id	int	Y	2	pms-storeID
room_id	int	N	19	房间ID

返回结果

名称	类型	描述
sub_room_id	int	子房间ID
sub_room_no	string	子房间号

返回示例

json

{
    "error_code": 0,
    "description": "success",
    "error_msg": "success",
    "data": [
        {
            "sub_room_id": 1,
            "sub_room_no": "A"
        },
        {
            "sub_room_id": 2,
            "sub_room_no": "B"
        }
    ]
}

第三方渠道

获取第三方渠道列表

接口地址

POST /api/v1/channel/channelList

请求参数

名称	类型	是否必需	示例	描述
pms_id	int	Y	2	pms-storeID

返回结果

名称	类型	描述
channel_id	int	渠道ID
type	int	渠道类型 1:OTA 2:第三方
type_name	string	渠道类型名称
channel_type	int	渠道类型 10:飞猪 20:携程 30:途家 40:美团酒店 50:小猪民宿 60:木鸟民宿
name	string	渠道名称
icon	string	渠道图标
sort	int	排序
protocol_url	string	协议地址
channel_info	object	渠道信息
channel_info.status	int	状态 1：已开通 2：未开通 3：审核中 4：审核失败
channel_info.status_name	string	状态名称
channel_info.expired_date	string	过期时间
channel_info.connect_status	int	连接状态 1：直连中 2：未直连

返回示例

json

{
    "error_code": 0,
    "description": "success",
    "error_msg": "success",
    "data": [
        {
            "channel_id": 1,
            "type": 1,
            "type_name": "OTA",
            "channel_type": 10,
            "name": "飞猪",
            "icon": "http://hotel.local.star-lock.cn/storage/channel/619a4acc-17a6-40cc-b762-c77134e29a05.png",
            "sort": 1,
            "protocol_url": "http://hotel.local.star-lock.cn/agreement/fj-notice",
            "channel_info": {}
        }
    ]
}

申请开通渠道

接口地址

POST /api/v1/channel/applyOpen

请求参数

名称	类型	是否必需	示例	描述
pms_id	int	Y	2	pms-storeID
channel_id	int	Y	1	渠道ID
name	string	Y	"渠道名称"	渠道名称
contact	string	Y	"联系方式"	联系人方式手机号/邮箱/微信号/QQ号

返回示例

json

{
    "error_code": 0,
    "description": "success",
    "error_msg": "success",
    "data": {}
}

PMS住宿设置 ​

房型房间设置 ​

获取房型列表 ​

创建房型 ​

更新房型 ​

删除房型 ​

更新房间 ​

更新房型排序 ​

获取房型Select列表 ​

下载房型导入模板 ​

导入房型 ​

更新房间排序 ​

钟点房设置 ​

获取可选房型列表 ​

添加钟点房 ​

更新钟点房 ​

删除钟点房 ​

获取钟点房列表 ​

包栋设置 ​

添加包栋 ​

更新包栋 ​

删除包栋 ​

获取包栋列表 ​

早餐设置 ​

添加早餐 ​

更新早餐 ​

获取早餐列表 ​

删除早餐 ​

消费项设置 ​

添加消费项分组 ​

更新消费项分组 ​

删除消费项分组 ​

更新消费排序 ​

获取消费项分组列表 ​

获取消费类别 ​

更新消费分组排序 ​

添加消费项 ​

更新消费项 ​

删除消费项 ​

获取消费项列表 ​

房价分组设置 ​

更新房间分组设置 ​

获取房间分组数据 ​

获取所有分组Select列表 ​

更新分组排序 ​

订单盒子设置 ​

添加订单盒子标签 ​

更新订单盒子标签 ​

删除订单盒子标签 ​

获取订单盒子标签select列表 ​

门锁设置 ​

添加设备（由APP对接） ​

删除设备（由APP接入） ​

获取设备列表（web接入） ​

更新门锁 ​

生成关联场景 ​

楼栋设置 ​

添加楼栋 ​

更新楼栋 ​

获取楼栋列表 ​

删除楼栋 ​

分区设置 ​

添加分区 ​

更新分区 ​

获取全部分区 ​

删除分区 ​

房间设置 ​

关联房间到楼层 ​

删除房间关联 ​

获取房间关联列表 ​

获取指定房间下的子房间列表 ​

第三方渠道 ​

获取第三方渠道列表 ​

申请开通渠道 ​

PMS住宿设置

房型房间设置

获取房型列表

创建房型

更新房型

删除房型

更新房间

更新房型排序

获取房型Select列表

下载房型导入模板

导入房型

更新房间排序

钟点房设置

获取可选房型列表

添加钟点房

更新钟点房

删除钟点房

获取钟点房列表

包栋设置

添加包栋

更新包栋

删除包栋

获取包栋列表

早餐设置

添加早餐

更新早餐

获取早餐列表

删除早餐

消费项设置

添加消费项分组

更新消费项分组

删除消费项分组

更新消费排序

获取消费项分组列表

获取消费类别

更新消费分组排序

添加消费项

更新消费项

删除消费项

获取消费项列表

房价分组设置

更新房间分组设置

获取房间分组数据

获取所有分组Select列表

更新分组排序

订单盒子设置

添加订单盒子标签

更新订单盒子标签

删除订单盒子标签

获取订单盒子标签select列表

门锁设置

添加设备（由APP对接）

删除设备（由APP接入）

获取设备列表（web接入）

更新门锁

生成关联场景

楼栋设置

添加楼栋

更新楼栋

获取楼栋列表

删除楼栋

分区设置

添加分区

更新分区

获取全部分区

删除分区

房间设置

关联房间到楼层

删除房间关联

获取房间关联列表

获取指定房间下的子房间列表

第三方渠道

获取第三方渠道列表

申请开通渠道