API文档

订单接口

接口列表

接口名称 接口方法 说明
1.添加订单 Order.Add 办理预订下单接口
2.添加自定义价订单 Order.AddOrderWithCustomPrice 办理预订下单接口，支持自定义价格
3.取消订单 Order.Cancel 取消订单接口
4.查询单个订单信息 Order.QuerySingleOrder 查询单个订单信息
5.查询订单 Order.QueryOrders 查询订单
6.查询可用市场活动 Order.QueryOrderAvailablePromotions 根据预订单条件查询可用的市场活动列表
7.排房 Order.DispatchRoom 预定单排房
8.办理入住 Order.AddCheckin 办理入住
9.查询入住信息 Order.QueryCheckins 查询入住信息
10.查询在住单智能门锁信息 Order.QueryCheckinSmartDoorLocks 查询在住单智能门锁信息
11.开门 Order.OpenCheckinSmartDoorLock 开门
12.查询未生成过房费的房间号 Order.QueryUnGeneratedRoomRent 查询未生成过房费的房间号
13.查询需要加收房费的房间 Order.QueryRoomRateCharge 查询需要加收房费的房间
14.退房 Order.Checkout 退房
15.变更离店日期 Order.ChangeStay 变更离店日期
16.换房 Order.ChangeRoom 仅支持入住人与同住人一起换房，不支持单个换房
17.修改订单备注 Order.UpdateOrderMemo 修改预订单备注
18.修改入住单备注 Order.UpdateCheckinMemo 修改入住单备注，即入住客人备注

1.添加订单

Order.Add

应用场景

客户办理预定业务，预订下单接口

请求参数

字段名 变量名 必填 类型 示例值 描述
入住类型 CheckinType 是 string Normal 正常：Normal，长包：LongTerm，Trip：旅行团，会议：Conference，免费：Free，时租一小时到时租十二小时，酒店具体有哪些时租类型可在pms系统->系统设置->酒店信息维护->时租房信息中查看
酒店Id OrgId 是 long
预抵时间 EstimatedArriveTime 是 DateTime
预离时间 EstimatedDepartureTime 是 DateTime
订房计划 RoomPlans 是 AddRoomPlan[]
会员Id MemberId 否 string
中介/协议公司Id ContractId 否 long
销售人员Id SalerId 否 string
联系人信息 Liaisons 是 Liaison[]
是否锁房 Locked 是 bool
保留时间 ExpireKeepTime 否 DateTime
担保类型 PrePaymentTypeId 否 string
促销策略Id PromotionId 否 long 0 如果没有促销策略就传入0
订单备注 Memo 否 string
优惠服务包 ServiceItems 否 OrderServiceItem[] 如：叫早
订单号 OrderSn 否 string
微信Id(特定商户使用) OpenId 否 string

AddRoomPlan

字段名 变量名 必填 类型 示例值 描述
价格房型Id RoomTypeId 是 string
数量 Count 是 int

Liaison

字段名 变量名 必填 类型 示例值 描述
姓名 Name 否 string
手机 Mobile 否 string

OrderServiceItem

字段名 变量名 必填 类型 示例值 描述
服务项Id ItemId 是 long
价格 ItemPrice 是 decimal
数量 ItemCount 是 int
是否客人自己付费购买 CustomerOwned 是 bool
是否刷新后保留 PersistentOnRefresh 是 bool

示例

                        {
     "ChannelKey":"web",
     "Method":"Order.Add",
     "BizContent":"{\"CheckinType\":\"Normal\",\"OrgId\":660247752032257,
     \"EstimatedArriveTime\":\"2017-12-20 11:07:42\",\"EstimatedDepartureTime\":\"2017-12-21 11:07:42\",
     \"RoomPlans\":[{\"RoomTypeId\":\"DR\",\"Count\":1}],\"ContractId\":0,
     \"Liaisons\":[{\"Name\":\"核庭沸慰\",\"Mobile\":\"13013876047\"}],
     \"Locked\":false,\"ExpireKeepTime\":\"2017-12-20 17:07:42\",\"PrePaymentTypeId\":\"Full\"}",
     "Sign":"FC6039B16380E11716CE19E827FDC880",
     "SignType":"MD5",
     "Format":"json",
     "Charset":"utf-8",
     "Version":"1.0",
     "Timestamp":"2017-02-12 14:12:13"
}

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

{
    "CheckinType":"Normal",
    "OrgId":660247752032257,
    "EstimatedArriveTime":"2017-12-20 11:07:42",
    "EstimatedDepartureTime":"2017-12-21 11:07:42",
    "RoomPlans":[
        {
            "RoomTypeId":"DR","Count":1
        }],
        "ContractId":0,
        "Liaisons":[
            {"Name":"核庭沸慰",
            "Mobile":"13013876047"
        }],
        "Locked":false,
        "ExpireKeepTime":"2017-12-20 17:07:42",
        "PrePaymentTypeId":"Full"
}

返回结果

字段名 变量名 必填 类型 示例值 描述
long 678728342011909 返回订单Id

示例

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

业务异常码表

Code
（返回码） 		Message
（返回码描述） 		SubCode
（业务返回码） 		SubMessage
（业务返回码描述） 		解决方案
50000 业务处理失败 order.missing-necessary-order-info 缺少必要的预订信息 预定的信息填写完整
order.missing-room-type 缺少房型信息 填写完整房型信息
order.invalid-room-type-order-number 预订的房间数量无效
order.order-already-exist 订单已存在
order.member-not-exist 会员不存在
order.abnormal-member-status 会员状态异常

2.添加自定义价订单

Order.AddOrderWithCustomPrice

应用场景

客户办理预定业务，预订下单接口，可以传入自定义价格

请求参数

字段名 变量名 必填 类型 示例值 描述
入住类型 CheckinType 是 string Normal 正常：Normal，长包：LongTerm，Trip：旅行团，会议：Conference，免费：Free，时租一小时到时租十二小时，酒店具体有哪些时租类型可在pms系统->系统设置->酒店信息维护->时租房信息中查看
酒店Id OrgId 是 long
预抵时间 EstimatedArriveTime 是 DateTime
预离时间 EstimatedDepartureTime 是 DateTime
订房计划 RoomPlans 是 CustomPriceRoomPlan[]
会员Id MemberId 否 string
中介/协议公司Id ContractId 否 long
销售人员Id SalerId 否 string
联系人信息 Liaisons 是 Liaison[]
是否锁房 Locked 是 bool
保留时间 ExpireKeepTime 否 DateTime
预付类型 PrePaymentTypeId 否 string
订单备注 Memo 否 string
自定义价格名称 ExternalPriceName 否 string
优惠服务包 ServiceItems 否 OrderServiceItem[] 如：叫早
订单号 OrderSn 否 string
微信Id(特定商户使用) OpenId 否 string
使用客户指定的离店时间(特定商户使用) UseCustomCheckoutTime 否 bool

CustomPriceRoomPlan

字段名 变量名 必填 类型 示例值 描述
价格房型Id RoomTypeId 是 string
数量 Count 是 int
价格详情 Price 是 CustomRoomPrice[]

Liaison

字段名 变量名 必填 类型 示例值 描述
姓名 Name 否 string
手机 Mobile 否 string

CustomRoomPrice

字段名 变量名 必填 类型 示例值 描述
日期 Date 是 DateTime 2018-08-18 日期不包含时、分、秒
优惠价 ActualPrice 是 decimal 86
房型Id RoomTypeId 是 string DR

示例

                        {
     "ChannelKey":"web",
     "Method":"Order.Add",
     "BizContent":"{\"CheckinType\":\"Normal\",\"OrgId\":660247752032257,
     \"EstimatedArriveTime\":\"2017-12-20 11:07:42\",\"EstimatedDepartureTime\":\"2017-12-21 11:07:42\",
     \"RoomPlans\":[{\"RoomTypeId\":\"DR\",\"Count\":1,\"Price\":[{\"ActualPrice\":248,
     \"RoomTypeId\":\"DR\",\"Date\":\"2017-12-20\"}]}],\"ContractId\":0,
     \"Liaisons\":[{\"Name\":\"核庭沸慰\",\"Mobile\":\"13013876047\"}],
     \"Locked\":false,\"ExpireKeepTime\":\"2017-12-20 17:07:42\",\"PrePaymentTypeId\":\"Full\",
     \"IsExtenalPrice\":false}",
     "Sign":"FC6039B16380E11716CE19E827FDC880",
     "SignType":"MD5",
     "Format":"json",
     "Charset":"utf-8",
     "Version":"1.0",
     "Timestamp":"2017-02-12 14:12:13"
}

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

{
    "CheckinType":"Normal",
    "OrgId":660247752032257,
    "EstimatedArriveTime":"2017-12-20 11:07:42",
    "EstimatedDepartureTime":"2017-12-21 11:07:42",
    "RoomPlans":[
        {
            "RoomTypeId":"DR","Count":1,
            "Price":[
                {
                "ActualPrice":248,
                "RoomTypeId":"DR",
                "Date":"2017-12-20"
            }]
        }],
        "ContractId":0,
        "Liaisons":[
            {"Name":"核庭沸慰",
            "Mobile":"13013876047"
        }],
        "Locked":false,
        "ExpireKeepTime":"2017-12-20 17:07:42",
        "PrePaymentTypeId":"Full",
        "IsExtenalPrice":false
}

返回结果

字段名 变量名 必填 类型 示例值 描述
long 678728342011909 返回订单Id

示例

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

业务异常码表

Code
（返回码） 		Message
（返回码描述） 		SubCode
（业务返回码） 		SubMessage
（业务返回码描述） 		解决方案
50000 业务处理失败 order.missing-necessary-order-info 缺少必要的预订信息 预定的信息填写完整
order.missing-room-type 缺少房型信息 填写完整房型信息
order.invalid-room-type-order-number 预订的房间数量无效
order.order-already-exist 订单已存在
order.member-not-exist 会员不存在
order.abnormal-member-status 会员状态异常
BargainingPriceInvalid 自定义价格过低 可以在权限管理->角色->接口外部价中调整自定义价格级别

3.取消订单

Order.Cancel

应用场景

客人行程变动或其他原因不能按时抵店办理入住时，可根据此接口进行取消订单操作

请求参数

字段名 变量名 必填 类型 示例值 描述
酒店Id OrgId 是 long
订单Id OrderId 是 long
取消原因 Reason 是 string

示例

{
    "ChannelKey": "web",
    "Method": "Order.Cancel",
    "BizContent":"{\"OrgId\":2147483644,\"OrderId\":678797490651142,
    \"Reason\":\"行程改变\"}",
    "Sign": "9BEF9E5C9907ECEE738CCFDFC2F28AAE",
    "SignType": "MD5",
    "Format": "json",
    "Charset": "utf-8",
    "Version": "1.0",
    "Timestamp": "2017-12-18 10:12:13"
}

返回结果

字段名 变量名 必填 类型 示例值 描述
是 bool 成功或失败

示例

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

业务异常码表

Code
（返回码） 		Message
（返回码描述） 		SubCode
（业务返回码） 		SubMessage
（业务返回码描述） 		解决方案
50000 业务处理失败 order.invalid-order-id 无效的订单Id
order.order-not-found 订单不存在
order.order-have-checkedin 订单已入住

4.查询单个订单信息

Order.QuerySingleOrder

应用场景

获取单个订单详情

请求参数

字段名 变量名 必填 类型 示例值 描述
酒店Id OrgId 是 long
订单Id OrderId 此三个必须选择一个 long
订单号 OrderSn string 订单号（外部）
渠道订单号 ChannelOrderSn string
是否包含酒店信息 IncludeOrgInfo 是 bool
是否排除查询占房信息 ExcludeOccupations 是 bool
是否查询订单的余额 SearchBalance 是 bool

示例

{
    "ChannelKey":"web",
    "Method":"Order.QuerySingleOrder",
    "BizContent":"{\"OrgId\":660247752032257,\"OrderId\":678728342011909,\"IncludeOrgInfo\":false,
    \"ExcludeOccupations\":false,\"SearchBalance\":false}",
    "Sign":"58B502A80286015EECBDDE06C2BA02A4",
    "SignType":"MD5",
    "Format":"json",
    "Charset":"utf-8",
    "Version":"1.0",
    "Timestamp":"2017-02-12 14:12:13"
}

返回结果

OrderInfo

字段名 变量名 必填 类型 示例值 描述
酒店Id OrgId 是 long
酒店信息 OrgInfo 是 OrgInfo
订单Id OrderId 是 long
订单号 OrderNo 是 string
账务Id BillId 是 long
客源类别 CustomerCategory 是 string
订单来源 OrderSource 是 strting
入住类别 CheckinType 是 string
订单状态 OrderStatus 是 string
预计抵店时间 EstimatedArriveTime 是 DateTime
预计离店时间 EstimatedDepartureTime 是 DateTime
实际抵店时间 ActualArriveTime 是 DateTime
备注 Memo 是 string
渠道 Channel 是 string
预付类型 PrePaymentTypeId 是 string
市场活动Id PromotionId 是 long
是否锁单 Locked 是 bool
取消原因 CancelReason 是 string
联系人信息 Liaisons 是 Liaison[]
订房计划 RoomPlans 是 RoomPlan[]
最晚保留时间 ExpireKeepTime 是 DateTime
权益离店时间 BenefitDepartureTime 否 DateTime
创建时间 CreateTimeInUtc 是 DateTime
会员ID MemberId 是 string
协议公司Id ContractorId 是 long
微信OpenId OpenId 是 string
渠道订单号 ChannelOrderSn 是 string
订单所包含的占房 Occupations 是 OccupationModel[] Order.QueryOrders接口不包含该项值
订单余额 Balance 是 decimal Order.QueryOrders接口不包含该项值

OrgInfo

字段名 变量名 必填 类型 示例值 描述
酒店Id OrgId 否 long
酒店编号 OrgSn 否 string
酒店名称 OrgName 否 string
酒店类别 OrgInfoType 否 string
品牌 Brand 否 string
地址 Address 是 string
电话 Phone 是 string
传真 Fax 是 string
描述 Description 是 string
星级 Star 是 int
经度 Longitude 是 string
纬度 Latitude 是 string
服务内容 ServiceTags 是 string
是否能用网络锁 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[]
酒店状态 OrgStatus 是 string 酒店状态（开业，筹备，试营业，关闭）

RoomPlan

字段名 变量名 必填 类型 示例值 描述
房号 RoomNumbers 是 string[]
价格房型Id RoomTypeId 是 string
房型信息 RoomType 是 RoomType
数量 Count 是 int
价格信息 Price 是 Price[]
物理房型ID PhysicalRoomTypeId 是 string

RoomType

字段名 变量名 必填 类型 示例值 描述
床数 BedAmount 是 int
床型 BedType 是 string
房型描述 Description 是 string
房型ID Id 是 string
是否虚房型 Virtual 是 bool
缩写 Abbreviation 是 string
是否有效 IsActive 是 bool

Price

字段名 变量名 必填 类型 示例值 描述
占房日 Date 是 datetime 017-12-20T00:00:00 不包含时分秒
门市价 OrignPrice 是 decimal 单位元，保留2位小数
实际价格 ActualPrice 是 decimal 单位元，保留2位小数
房型ID RoomTypeId 是 string
描述 Description 是 string

OccupationModel

字段名 变量名 必填 类型 示例值 描述
订单ID OrderId 否 long
占房Id OccupationId 否 long
分配房间类型 PhysicalRoomTypeId 否 string 最终入住的物理房型ID
未分配房间类型 PriceRoomTypeId 否 string 价格房型、可能是虚拟房型ID
房号 RoomNumber 否 string
预订单明细开始时间 OccupationStartTime 是 DateTime
预定单明细结束时间 OccupationEndTime 是 DateTime
是否有效 IsActive 是 bool
是否锁定订单 Locked 是 bool
是否是本人本卡 [定价人等于主单入住人] IsMemberThemself 是 bool
是否入住 HasCheckin 是 bool

示例

{
    "Code":10000,
    "Message":null,
    "SubCode":null,
    "SubMessage":null,
    "Data":{
        "OrgId":660247752032257,
        "OrgInfo":null,
        "OrderId":678728342011909,
        "OrderNo":"2OCE866E005",
        "BillId":678728346206215,
        "CustomerCategory":"Normal",
        "OrderSource":"Web",
        "CheckinType":"Normal",
        "OrderStatus":"InProgress",
        "EstimatedArriveTime":"2017-12-20T11:07:42",
        "EstimatedDepartureTime":"2017-12-21T11:07:42",
        "ActualArriveTime":null,
        "Memo":null,"Channel":"Web",
        "PrePaymentTypeId":"Full",
        "PromotionId":0,"Locked":false,
        "CancelReason":null,
        "Liaisons":[{
            "Name":"核庭沸慰",
            "Mobile":"13013876047"
        }],
        "RoomPlans":[{
            "RoomTypeId":"DR",
            "PhysicalRoomTypeId":"DR",
            "RoomTypeModel":{
                "Id":"DR",
                "RoomTypeName":"豪华圆床房",
                "Description":null,
                "HotelRoomTypeDescription":null,
                "BedAmount":14,"BedType":null,
                "Virtual":false,"PhysicalRoomTypeId":null,
                "Abbreviation":"豪圆","IsActive":false,"ImageUris":null},
                "Count":1,"Price":[{
                        "Date":"2017-12-20T00:00:00",
                        "OrignPrice":248.00,
                        "ActualPrice":248.00,
                        "RoomTypeId":"DR",
                        "RoomTypeModel":null,
                        "RoomCount":0,
                        "Description":null}],
                        "RoomNumbers":[]}],
                        "ExpireKeepTime":"2017-12-20T17:07:42",
                        "CreateTimeInUtc":"2017-12-20T03:07:42.413",
                        "MemberId":null,
                        "ContractorId":0,
                        "OpenId":null,
                        "Occupations":[{
                            "OrderId":678728342011909,
                            "OccupationId":678728346206215,
                            "PhysicalRoomTypeId":"DR",
                            "PriceRoomTypeId":"DR",
                            "RoomNumber":null,
                            "OccupationStartTime":"2017-12-20T12:00:00",
                            "OccupationEndTime":"2017-12-21T11:07:42",
                            "IsActive":true,
                            "Locked":false,
                            "IsMemberThemself":false,
                            "HasCheckin":false}],
                        "Balance":0.0}
}

5.查询订单

Order.QueryOrders

应用场景

查询酒店订单

请求参数

字段名 变量名 必填 类型 示例值 描述
酒店Id OrgId 否 long
会员Id MemberId 否 string
微信账号 OpenId 否 string
查询条件 Keywords 否 string 此处可以是Pms订单号(OrderSn)，渠道订单号(ChannelOrderSn),预订人或者联系人的姓名和手机号
渠道 Channel 否 string
是否包含酒店Id IncludeOrgInfo 是 bool
开始时间 BeginTime 否 DateTime 创建订单时间（查询条件范围开始时间），默认是上月的当前时间，如果上月没有当前日期，则为上月的最后一天
结束时间 EndTime 否 DateTime 创建订单时间（查询条件范围结束时间），默认是当前时间
订单状态 OrderStatusIds 否 string[] 预定中：InProgress，订单完结：Finish
房间号 RoomNumber 否 string 只能查询已经分房未入住的订单
是否模糊搜索姓名 IsFuzzyName 否 bool 小明 设置true时 Keyword参数传姓名且至少2个字符
每页条数 PageSize 否 int 默认10
页码 PageIndex 否 int 页码从1开始

示例

{
    "ChannelKey":"web",
    "Method":"Order.QueryOrders",
    "BizContent":"{\"PageSize\":1000,\"PageIndex\":1,\"OrgId\":660247752032257,
    \"OrderStatusIds\":[\"InProgress\"]}",
    "Sign":"5788282EB693B58F077C83AFAD29D156",
    "SignType":"MD5",
    "Format":"json",
    "Charset":"utf-8",
    "Version":"1.0",
    "Timestamp":"2017-02-12 14:12:13"
}

返回结果

字段名 变量名 必填 类型 示例值 描述
分页大小 PageSize 是 int
页码 PageIndex 是 int
总记录数 RecordCount 是 int
分页数量 PageCount 是 int
Content 是 OrderInfo[]

示例

{
    "Code":10000,
    "Message":null,
    "SubCode":null,
    "SubMessage":null,
    "Data":{
    "PageSize":1000,
    "PageIndex":1,
    "RecordCount":0,
    "PageCount":0,"
    "Content":[
    "OrgId":660247752032257,
    "OrgInfo":null,
    "OrderId":678728342011909,
    "OrderNo":"2OCE866E005",
    "BillId":678728346206215,
    "CustomerCategory":"Normal",
    "OrderSource":"Web",
    "CheckinType":"Normal",
    "OrderStatus":"InProgress",
    "EstimatedArriveTime":"2017-12-20T11:07:42",
    "EstimatedDepartureTime":"2017-12-21T11:07:42",
    "ActualArriveTime":null,
    "Memo":null,"Channel":"Web",
    "PrePaymentTypeId":"Full",
    "PromotionId":0,"Locked":false,
    "CancelReason":null,
    "Liaisons":[{
        "Name":"核庭沸慰",
        "Mobile":"13013876047"
    }],
    "RoomPlans":[{
        "RoomTypeId":"DR",
        "PhysicalRoomTypeId":"DR",
        "RoomTypeModel":{
            "Id":"DR",
            "RoomTypeName":"豪华圆床房",
            "Description":null,
            "HotelRoomTypeDescription":null,
            "BedAmount":14,"BedType":null,
            "Virtual":false,"PhysicalRoomTypeId":null,
            "Abbreviation":"豪圆","IsActive":false,"ImageUris":null},
            "Count":1,"Price":[{
                "Date":"2017-12-20T00:00:00",
                "OrignPrice":248.00,
                "ActualPrice":248.00,
                "RoomTypeId":"DR",
                "RoomTypeModel":null,
                "RoomCount":0,
                "Description":null}],
                "RoomNumbers":[]}],
                "ExpireKeepTime":"2017-12-20T17:07:42",
                "CreateTimeInUtc":"2017-12-20T03:07:42.413",
                "MemberId":null,
                "ContractorId":0,
                "OpenId":null,
                "Occupations":[{
                    "OrderId":678728342011909,
                    "OccupationId":678728346206215,
                    "PhysicalRoomTypeId":"DR",
                    "PriceRoomTypeId":"DR",
                    "RoomNumber":null,
                    "OccupationStartTime":"2017-12-20T12:00:00",
                    "OccupationEndTime":"2017-12-21T11:07:42",
                    "IsActive":true,
                    "Locked":false,
                    "IsMemberThemself":false,
                    "HasCheckin":false}],
                "Balance":0.0}]
}

6.查询可用市场活动

Order.QueryOrderAvailablePromotions

应用场景

查询订单可用的市场活动，此时参数中的 联系人信息(Liaisons) 不用传值

请求参数

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

示例

{
    "ChannelKey":"web",
    "Method":"Order.QueryOrderAvailablePromotions",
    "BizContent":"{\"CheckinType\":\"Normal\",\"OrgId\":660247752032257,
    \"EstimatedArriveTime\":\"2017-12-20 11:07:40\",\"EstimatedDepartureTime\":\"2017-12-24 11:07:40\",
    \"RoomPlans\":[{
        \"RoomTypeId\":\"DR\",
        \"Count\":1,
        \"Price\":[{
            \"OrignPrice\":248,
            \"ActualPrice\":248,
            \"RoomTypeId\":\"DR\",
            \"RoomCount\":1}]
        }],
        \"ContractId\":0,
        \"Liaisons\":[{
            \"Name\":\"A\",
            \"Mobile\":\"13086846391\"}],
    \"Locked\":false,
    \"ExpireKeepTime\":\"2017-12-20 17:07:40\",
    \"PrePaymentTypeId\":\"Full\",
    \"PromotionId\":0,
    \"IsExtenalPrice\":false}",
    "Sign":"70868D666610C02D1C44271D48AC2BA9",
    "SignType":"MD5",
    "Format":"json",
    "Charset":"utf-8",
    "Version":"1.0",
    "Timestamp":"2017-02-12 14:12:13"
}

返回结果

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

PromotionInfo

字段名 变量名 必填 类型 示例值 描述
市场活动Id PromotionId 是 long
名称 Name 是 string
描述 Description 是 string
活动开始时间 BeginTime 是 DateTime
活动结束时间 EndTime 是 DateTime
是否锁单 LockOrder 是 bool
是否作用在基础价 BaseOnBasicPrice 是 bool
是否有效 IsActive 是 bool
限定的订单数 Ceiling 是 int
剩余可订订单数 Remain 是 int
价格详情 DetailPrices 是 RoomPrice

RoomPrice

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

示例

{
    "Code":10000,
    "Message":null,
    "SubCode":null,
    "SubMessage":null,
    "Data":[{
        "PromotionId":660261509349377,
        "Name":"WebAPI豪园房型活动",
        "Description":null,
        "BeginTime":"2017-11-01T00:00:00",
        "EndTime":"2020-12-22T00:00:00",
        "LockOrder":false,
        "BaseOnBasicPrice":true,
        "IsActive":true,
        "Ceiling":null,
        "Remain":0,
        "DetailPrices":null}
        ]
}

7.排房

Order.DispatchRoom

应用场景

预定单排房

请求参数

字段名 变量名 必填 类型 示例值 描述
酒店Id OrgId 是 long
占房Id OccupationId 是 long
房间号 RoomNumber 是 string

示例

                        {
     "ChannelKey":"web",
     "Method":"Order.DispatchRoom",
     "BizContent":"{\"OrgId\":660247752032257,\"OccupationId\":678728337817604,
     \"RoomNumber\":\"1101\"}",
     "Sign":"E7B1807E14B16A3A1411DEB88A652C77",
     "SignType":"MD5",
     "Format":"json",
     "Charset":"utf-8",
     "Version":"1.0",
     "Timestamp":"2017-02-12 14:12:13"
}

返回结果

字段名 变量名 必填 类型 示例值 描述
否 bool true，false 成功或失败

示例

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

8.办理入住

Order.AddCheckin

应用场景

办理入住

请求参数

字段名 变量名 必填 类型 示例值 描述
订单Id OrderId 是 long
占房Id OccupationId 否 long
酒店Id OrgId 是 long
入住客人信息 Customer 是 CheckinCustomer

CheckinCustomer

字段名 变量名 必填 类型 示例值 描述
客人姓名 Name 是 string
证件类型Id CardTypeId 是 string 参考数据字典中的PersonalCredentialType
证件号 CardNo 是 string
手机号码 Mobile 否 string
是否本人本卡 ThemSelfCheckin 是 bool
国籍 Nationality 否 string
省 Province 否 string
市 City 否 stirng
区 District 否 stirng
地址 Address 否 string
民族 Race 否 string 民族对照表
性别 Gender 否 int 0：未知、1：女、2：男
生日 Birthday 否 datetime
照片 Photo 否 string base64字符，最大支持4.5万个字符。格式Photo:"data:image/png;base64,照片数据"

示例

                              
{
      "ChannelKey": "web",
     "Method": "Order.AddCheckin",
     "BizContent":"{\"OrderId\":902138057048065,\"OccupationId\":902138057048065,
         \"OrgId\":2147483644,\"Customer\":{\"Name\":\"掌上3\",\"CardTypeId\":\"C01\",
         \"CardNo\":\"110101189003033831\",\"Mobile\":\"18601701916\",\"ThemSelfCheckin\":false,
         \"Birthday\":\"2011-11-11\",\"Province\":\"安徽\",\"City\":\"合肥\",\"District\":\"舒城\",
         \"Gender\":2,\"Address\":\"he山洼1\",\"Race\":\"\",
         \"Photo\":\"data:image/png;base64,/9j/4AAQSkZJRgABAQAAAQABAAD//gA7Q1JFQVRPUjogZ2QtanBlZyB2MS4wICh1c2luZyBJSkcgSlBFRyB2OTApLCBxdWFsaXR5ID0gNzAK/9sAQwAKBwcIBwYKCAgICwoKCw4YEA4NDQ4dFRYRGCMfJSQiHyIhJis3LyYpNCkhIjBBMTQ5Oz4+PiUuRElDPEg3PT47/9sAQwEKCwsODQ4cEBAcOygiKDs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7/8AAEQgAyAB9AwEiAAIRAQMRAf/EAB8AAAEFAQEBAQEBAAAAAAAAAAABAgMEBQYHCAkKC//EALUQAAIBAwMCBAMFBQQEAAABfQECAwAEEQUSITFBBhNRYQcicRQygZGhCCNCscEVUtHwJDNicoIJChYXGBkaJSYnKCkqNDU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6g4SFhoeIiYqSk5SVlpeYmZqio6Slpqeoqaqys7S1tre4ubrCw8TFxsfIycrS09TV1tfY2drh4uPk5ebn6Onq8fLz9PX29/j5+v/EAB8BAAMBAQEBAQEBAQEAAAAAAAABAgMEBQYHCAkKC//EALURAAIBAgQEAwQHBQQEAAECdwABAgMRBAUhMQYSQVEHYXETIjKBCBRCkaGxwQkjM1LwFWJy0QoWJDThJfEXGBkaJicoKSo1Njc4OTpDREVGR0hJSlNUVVZXWFlaY2RlZmdoaWpzdHV2d3h5eoKDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uLj5OXm5+jp6vLz9PX29/j5+v/aAAwDAQACEQMRAD8Aki+MesNGzyW2nAjoPLf/AOLqKb4y69FOiC00wq3JPlycf+P15a6GIqfMz3yO1JNK8j79284ySRUJO+5CT7nstp8VNXupWxa2PlKOT5b5+v3qzZPjRrUf7oWenPMrlXxG4XHYj5+9eVm/mRSkMrqpHzAGqZmYkksST3qkmaXPVbj4468kipFZ6XwPnYxSEE+3z1VPx48TZ+Ww0nHvFJ/8crzFnJpBTEeoN8efEmBt0/Ss98xSf/F03/hfHij/AJ8NJ/78y/8AxyvMvxo/GgD0z/hfHij/AJ8NJ/78y/8Axyl/4Xv4ox/x4aT/AN+Zf/jleZGlzmgD09fjr4oPWw0n/vzL/wDHKs2/xq8SzhgbTSVYdB5MnP8A5EryyM8gVZ37GV1HSk9iJN9D1GX4yeI1RWSz0s5HP7qT/wCLqsfjb4n3hRY6Tz38qT/45XFKsU9tiNj5nUrms+Qsp6d6iLZEZM9Mf4y+Joioaz0o59IZP/jlXoPi5rkkeZLKwRvQxv8A/F15nG8b2/lTjgjMbgcg+n0qezthdoxknO5TiolJ23BtmTOyMplRgA3GzPSqzsUjwp69afPCqqxWRGKHsetVWPFb2NRztgAd6jzQTn60lAwooxS7TQAlFO2N6UbDzQA2nAZpNp9KTkUASZwetWoWDLtbGDVLk1Kj8CgTRoqwtiChyfWmzyCQ5U5zyTRBiSMjdk9gaDEUUuyFc1FtTO2pCsjKw+bGKt291cxKTGCQx61X+yyvAZgMqOuO1NiuZIQVVsfXmm1dDepW3nHWo2BPNPA4pCCxx2qjQixT1G7rTwgFPCZ6CgBgUU4Lu471MkG5gO5qWJAkwUYY56CkaxpSkMitS5BYhR6k1M+n7I95IKnoRzVs2MouAFYYk55GQBVmeNbSJWIR3BAwMgAeuKV+x6McukoylU0SKWn6Bdap5gtIw7RgFkLAHHTIB61H/wAI7qEv2nybV5PspxNsGdv+NamkR2Ek80WomU2wXeWg+8PpXZ+F/DH2W+ivkv0MF/EyWL+XlpXOf9YnP3SPpXTCnGS1PMrwdOzWzPJWhZPvLgetAQg8V12s2tzdXLS3NgsEyboneKLYkjqecjoD9KyJdMKKvAGe2eQfStp4Oajzx1RzKqr2ZStXMbqwHINbrw2t5bqHkKnbwOmDWN5ZRsFcVc8wtAsZIIB4rz6sGmmOa6oSzZI02hskHp2NVbqFXuXMW0L6VbVl3jbhTn0qcwqfm2Dms+azITsznugzRu4wKRumKls7Zrq5SFTgucCuhJt2RvsOtoHuJkiQZZzgVoXFpFbzFLaZbgx8FhwM9605IGGlRWdkbYFCRcXKvwG9N3vWRBBIly0LoEJGCueCR71dSnyo6MK1KpZrcZB5xl8wKGGcGrBsQ1wxkk8tCerHk/SnpAot5LfBWQ/MFzTjAvmQ+eHLmPPXoRWN+x6qocsEpa9f+ATx75IpYBG6LH9xlPPFSWkcyO6ySxvLKv3SMtntVCOZ1AmimYSsfmGea1Ilia7dvOZZgchMdWI6ik1Y7aVSNWz1utN9LaieRcPabRgspIcRkD867nw3qSaZptlZ6kizT2su+J7R2MtvGwySQByM9vf2rgI5olsZbd1lWdmznPU10mnW9zqGsaZD4eV4NXhg3TTM5CsR69eMce9dVHTRnkZioTgpx6f195p+LI4LvTd1z4k01pEBdoU++78gHKgEEjGQe9cR9nd4VnLKDGADz19K9D8U6BpdzaRyX91YWPiO4kDTxNMdp4xjAzjPBriBZAw+S00W9sAICeCOtezhP3kXFnztVqDuhbi1S6sVQopnQcbOqj6ViMGimeF1IcHFdVHHEgG1wMR7SCM59MVnazAQy3EsWzA2FvX0rHM6CUPadRUK1/dMNsq/IwatwuAn3S3PrUbGN18xTuK9aat0oyNtfO/EdW5igbsZqZAoOM8H0qMYHY08DBzjivRguU0ep0dpYWFrc20eoybIbnDNA0m0x/KcFvqelPXw1LbaXc3rxl5YJAYvLkDrKnc8enrTNO8nWUR9QS2TyJEBmY4aQdNp9eBV7VJW1E2X9lQyW9tCfJZkOHiJOMMuenTmtpRUosKc3GSaOftpPNE77isp6ewqSBUEqym4LOOgNLqANnfzWxZHZcrvXoar20UmAzDaoYHJ6nFefyntLERg431/rcueaFDzLZgSqduf9qtuw0O+uG82G08uQx4LMcAk9/WodP1OzsiXeNWYnIDDNdHZePVhTMVizkelQ3JLRFvFK+n5W17kun+BNRcK9xdwBscEoSQfrxXRaX4Jewnllh1WeGSddsjQgAkexPI/CpfDXjFNWd457dYyuOK65YkOGX9KjmqJmVSu5w5JbHLz/D7TryZp7i6uJZHChmZuTt6VQk+Fdm8sktvqE8bvn5mAbGa7xiFTJrF1HxdpukfJPKGk/uIMmt4V6sdpHFKnGS+E4y9+HGo6dp0xt7mO+K/MBja/4ev51yl1El1Gout4GOU713U3xCF/M0cFtNEp+6xGK4rU/Ng1i6kf5UnO8HHPNdn1uc6UoVOxw1sPGK54mdPpsUUz+WhRDHuC5zurLudOlhYbonUMMjK9a6G2mP8AqmDMmMozY5qa4mDqguEkZBny9km3HrnNeCqrg9TCM2tzz1eevSnA5OBj8aaPQUpI49e4r3bWOkkGS6+nsa6drw6ZbrBcFJru4ZUuEwSREOVJI7nP6VzVtbNO2EHJOK6O1smRFMztIyjALc4HpUVK8YLTdmtKi6j8jL+xhblnC53MdqgVtWWiXF7t3DaKuWenxtIHfkk9a6a2nhsodxIGK891T0adBFCy8A2hAllnfd6Vpp4ctbF1VVDL64qS21iKV8syqp7s4UfrWwt3ZOFUzREsOCrhqh1JM39lTRm21jDZyb4xtyRXZabdeZAuSCQPWueniikgJjYEjmm6BqQW5MEnBzjJpqT6ilSVjrroM0BCj7wrkT4Rt3vnuZiWYnPJruSgNsDweK5LxJ4htNBtzLcyBSxwo7mrbcdjmpNSuh9j4c0yJx5kQkPoeRVDx14WsrjTI7iFFhZW2Er056frTNB8WyapBLcWthczJD9/ywuQPXBPNXNW1q31fwxdNC/mBSoZSNjKcjgjsaU5TUbszrJNPlPPJ7bydMgtw5muoj0I+Yj1qPKyqscwyYhj8+1S311tuUEYMm5e7cr/AI1jXF+jSfu3UYHLZPzGvPcHM8dROSzjmnQqZZlGeprrNQ0O0uopDCnk3C9V965aFGhuwjjaytg17HteZaHoyouDszprCzSKMFQM1ppHu6iq1jzGOeBWjEBurhlJt6npRSSsiSPESEmsnVtSlUKkanmt0QiVMdu9J/YIn2lAD9aE1cuztZHCXsN3JOpIkkU84AJFeseDk0q48JJb6pahpFY+SrR/OBj9Oao2ejzwsP8ARlJHetu3tLvb/BED1wOa6Y1bK1jL6unK7ZjRJfabegJzaO2AkjAuo/rUkxMV0sqHDA84rVuLNbePeRlh3NZLOMkse9c7ep1pHo+i3v2vT1RvvAVwfj/wbPrN5HdfavLjQYA2Fsetbvhm9wwTNdaYo5RhgCG7VrFtq5wVUqU3daM4LwHp9x4ftJYEmhuDMRmRgVKgdsd60dT8NqNO1KeOQtNPES20Y3Ecj8a6QabHHLuCKR64q75SGPbtGMdKuSlNamM6kFpBbnzTJexm2CpIzOhyCR055q1ollp09s8l+ju5b5TmpvF2jRaJ4uvLINtTPmJheityKx7e5RjIGlJCtgH1FYuOlonnuNnZG5rNw0N5GyIOQdxrlNVXF0swGN1djcot0T8o3oMEHrWDrtuptFkHOD1qoaNHs143iTafNmJTnqK1oJR0Nc5pbkwZHY1rwSfMKia1HB3ijorPDcetb+n24Zx6VzNpJjGDXSWNyAR/WszpgdJDAFUdKkMS+lRWc4deRVwLnvWiIbszF1WMCBuea4q4uMzMAeM12XiGQw2zbRk1xGmjzZmJ7mluzVPRG7oV2UmXOQQa9F0yYTxAE9uK87WOO0jDuyr6ZOK6nQ9Wh2KzNgY61cHZmOIhzw03Or3AcE0/txWNp2uwas0pt0fZE23cRwfpWurArmt0zyJQcXZnifxoVrbxVZXMYHz22GPrgmvPoEkkVpQB85ydpr0T4wSG98U2tpFBJMYrfLBBnGTXB39vc2LpGNpUrkArgj2IHes3KxlPR6HWaeVupiZAJFbjng1U1rSRbwSorOyE5AbtWdcXtzoMolK74y3K55/Cn3fjFNRh8mG3IJ6l6KlKUJHqqvCcfMxrEtFMyds1sW5+aqaJGx8xRgnrVuHO4YNTPUmnojdtuACDWxaSYYVj2R3JyOa04Mq2azaOmMjp7G54AznHatiGcFOeTXKwT+Wuc1etL8bvvVKlY0auWNWi88Feua5CGwudMvWZYRNEzEqN2CK6y4u1CEnkt0rPdnY7gAfaqQ7pGE2jJrGprJexkA+rE49hXfaLo9tYW4gAzkYBPPFY9vDvZMIByDn0rpYoguzOeBya1iY1G+hoWEEUMW2MAc88YqS4uo4IWxnCjkgdKrwS4t2fcDgHDZrK8R3pg0C5MUhV2TaGxnBNU3oec05SuzzvUbiPXfEct0lzHFJI20Ag7io4A96dqvhO1upI5VlETbcM46PWS2mwPlrS9f7RG27aO5+gqSbU7/Yke2SRkyGGD8pocROzIvGei3EuktcQxhvLILBRzjmuCsW23AB6GvbJIwFKv8wbuea8c1uzOm65c26jaI5CV47dR+ldtaHU5aUzR3GJ84O01dtmDf4VStnS7tFb+LvUls/ly7W6djXAux6l+qOks+3atiMgICCaw7WVcqc1sRSBwB2FZyRrFl08gDt3qQTeWD71X3HHPAq0kalMsBWRvcLm4KWwdu3PA5rKfxRDCjKsEzydPu4/nWgGUoUPIB4qFrKGRido/Kri11EldkFrqmt36k2sAjjA7uAa6Owi1ee3WO+ukiz3DbiKz9N04CQ5jxn/AGq6GygkRgpjTC9Ca3jKJrJxSJ9N0lYnYGWSRSMgk8H8KyfGUyR6db2bjKly7jOMgf8A666qFSqZ7kflWB42NrHoT3EsYd4GU8nHXjmj7R5s25XOBks7ayvVvoZjDGV4y2SB7GoSRdzyTWb7Y2I++3JPc1WC3OoR5iKJbht3P9BWTPd3SylY1Keo25B9+KHJXsccpJHodjci8tEwwLjg+/vXIfETw5cLKurRJuTaFlA6jHQ1qSM+g34m5Nvu+ZRyV/8ArV16taalpowyzRSr17EGvXnHmRxxfKzwrTLv7POFc/I/B9jW1LEfvL9Qah8XeGJvD2obkUmzmJMT+n+yfeodKv8AzEFtMfm/gJPX2rzKsGnc9KhUTXKzVs7wqNjHBHrW9aXOVAGPzrmngO7jrUsNxPbjB5FY3ujqV0dgs3y4JFWUfK43H6VzEOqgjLZFXo9RUYw1ZOLNlJGyFOPlqWHfnFUba9RsZYZPatKCaNuhHNS9DSLXQ0bQMuPWuksEJC7hnIrmYLlUnXkCt+LUbeGJcyDd6GqgRVd1ZGxPsitXkx0Ga8r8f6xNPBFpkRRknQSPzzkHgV1Ou+MrGCylgSUSOylSEOccV5X9nnjnimlR5FX5i/OGH1NdC7nC24xa7mSdduYm8hCUWPIVT6+9Upb67Zv3cr9OcGuh8YW9pqV1b39iUQzxfvBjGWHqema47LDoxFCjF62OJpX1Pc9S0xLy2dHKFiOAOtc9ol7caBPJYzLmHdkA/wAP0rqYypxuk6Dj3p1xosGpRbpQFYDhh/jXss5EyLUNOsvEekyW02JIpV+V1/hbsR9K8T1fSbrQdVksbkbZIzlWHRh2Ir02GS70nXJUt8PbpgmM9D9PetDxPoEHjrRRNZlV1C2BMSngt6qawqwuro1hKzsedaReC+URscSr1Hr71uPYgw8qM1wiG5029IIaKeF8MpGCCOoNeiaVfw6vponQ7XUYde4NeVVhyu62PWoVedWe5iS25jb5RxnpTokZjgAg1oTR/MQw79cVYtLSJsEnH1rPmNmrlOOK4/hJP1rX0y01G4mWKNRz3J6Vds7a3aYJvX8609WvYPDGizX7OpkC7YkJ+8x6UrtuyQ+XlV7nAXnjS6tb426QoBHLsZi2eAcGvXNL023/ALQtryICWzuIQ6Fm3bW71863bNJvlblnbJP1r0nwdd32q/C/VtPguZFubBvOt2RsMoGCR+Wa7nSi4WR5rrS5rtmfrPky+INQCkBDMxKg8DntWlM19ceHBab0iiwQgU4z9a461kvhcKfIaV0JLYzk+ua3ba/mEsZlgJjBIZT6HsK52mjVMjEq24SG8gVfMAO0jKSA/wBan1H4eS30q3WjGFLeQZ8qWTBQ+3qKdqUcF1NHLbqVChWKOu4D8e1dNperxpC8YlHynpjpTba1QcsXuS+H76HU7CGYPwy5xgZrqoIRsBzuA9Rj+VFFe03oeVJWZz2t2q22pi6jTcrr84FSWkS+at1ZM0T8blPeiiiwuhzXxY8KrPbL4nsoiHGFvEVcZ9H/AKH8K870PVX0u8Dg/un4kX1FFFcNSK1R1UpPc78RJcIHVgQwyCKmisxjsB6k0UV5b0dj2VqrnJ6zrptLphZAP5TYLnoayNX8R6jr7RC9kBSEYRFGAPf60UV2U4pJM8+rUk2430KM5/cgetd/8KWaCz1yVh+7S0csT0+6aKK6Y7nM9jEt769ls1u4iGx8rk+tbWn6nYXMAhLypc5/jA2+3NFFcclqzpUmdCOI/wB5B95NrBR1P9KY+lQSRRSxwRoXXn94UoorNG1kf//Z\"}}",
                "Sign": "D886438591326AA486B6DD29CBB5F435",
                "SignType": "MD5",
                "Format": "json",
                "Charset": "utf-8",
                "Version": "1.0",
                "Timestamp": "2018-08-06 18:12:13"
 }

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

                            
{
	"OrderId": 902138057048065,
	"OccupationId": 902138057048065,
	"OrgId": 2147483644,
	"Customer": {
		"Name": "掌上3",
		"CardTypeId": "C01",
		"CardNo": "110101189003033831",
		"Mobile": "18601701916",
		"ThemSelfCheckin": false,
		"Birthday": "2011-11-11",
		"Province": "安徽",
		"City": "合肥",
		"District": "舒城",
		"Gender": 2,
		"Address": "he山洼1",
		"Race": "",
		"Photo": "data:image/png;base64,/9j/4AAQSkZJRgABAQAAAQABAAD//gA7Q1JFQVRPUjogZ2QtanBlZyB2MS4wICh1c2luZyBJSkcgSlBFRyB2OTApLCBxdWFsaXR5ID0gNzAK/9sAQwAKBwcIBwYKCAgICwoKCw4YEA4NDQ4dFRYRGCMfJSQiHyIhJis3LyYpNCkhIjBBMTQ5Oz4+PiUuRElDPEg3PT47/9sAQwEKCwsODQ4cEBAcOygiKDs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7/8AAEQgAyAB9AwEiAAIRAQMRAf/EAB8AAAEFAQEBAQEBAAAAAAAAAAABAgMEBQYHCAkKC//EALUQAAIBAwMCBAMFBQQEAAABfQECAwAEEQUSITFBBhNRYQcicRQygZGhCCNCscEVUtHwJDNicoIJChYXGBkaJSYnKCkqNDU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6g4SFhoeIiYqSk5SVlpeYmZqio6Slpqeoqaqys7S1tre4ubrCw8TFxsfIycrS09TV1tfY2drh4uPk5ebn6Onq8fLz9PX29/j5+v/EAB8BAAMBAQEBAQEBAQEAAAAAAAABAgMEBQYHCAkKC//EALURAAIBAgQEAwQHBQQEAAECdwABAgMRBAUhMQYSQVEHYXETIjKBCBRCkaGxwQkjM1LwFWJy0QoWJDThJfEXGBkaJicoKSo1Njc4OTpDREVGR0hJSlNUVVZXWFlaY2RlZmdoaWpzdHV2d3h5eoKDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uLj5OXm5+jp6vLz9PX29/j5+v/aAAwDAQACEQMRAD8Aki+MesNGzyW2nAjoPLf/AOLqKb4y69FOiC00wq3JPlycf+P15a6GIqfMz3yO1JNK8j79284ySRUJO+5CT7nstp8VNXupWxa2PlKOT5b5+v3qzZPjRrUf7oWenPMrlXxG4XHYj5+9eVm/mRSkMrqpHzAGqZmYkksST3qkmaXPVbj4468kipFZ6XwPnYxSEE+3z1VPx48TZ+Ww0nHvFJ/8crzFnJpBTEeoN8efEmBt0/Ss98xSf/F03/hfHij/AJ8NJ/78y/8AxyvMvxo/GgD0z/hfHij/AJ8NJ/78y/8Axyl/4Xv4ox/x4aT/AN+Zf/jleZGlzmgD09fjr4oPWw0n/vzL/wDHKs2/xq8SzhgbTSVYdB5MnP8A5EryyM8gVZ37GV1HSk9iJN9D1GX4yeI1RWSz0s5HP7qT/wCLqsfjb4n3hRY6Tz38qT/45XFKsU9tiNj5nUrms+Qsp6d6iLZEZM9Mf4y+Joioaz0o59IZP/jlXoPi5rkkeZLKwRvQxv8A/F15nG8b2/lTjgjMbgcg+n0qezthdoxknO5TiolJ23BtmTOyMplRgA3GzPSqzsUjwp69afPCqqxWRGKHsetVWPFb2NRztgAd6jzQTn60lAwooxS7TQAlFO2N6UbDzQA2nAZpNp9KTkUASZwetWoWDLtbGDVLk1Kj8CgTRoqwtiChyfWmzyCQ5U5zyTRBiSMjdk9gaDEUUuyFc1FtTO2pCsjKw+bGKt291cxKTGCQx61X+yyvAZgMqOuO1NiuZIQVVsfXmm1dDepW3nHWo2BPNPA4pCCxx2qjQixT1G7rTwgFPCZ6CgBgUU4Lu471MkG5gO5qWJAkwUYY56CkaxpSkMitS5BYhR6k1M+n7I95IKnoRzVs2MouAFYYk55GQBVmeNbSJWIR3BAwMgAeuKV+x6McukoylU0SKWn6Bdap5gtIw7RgFkLAHHTIB61H/wAI7qEv2nybV5PspxNsGdv+NamkR2Ek80WomU2wXeWg+8PpXZ+F/DH2W+ivkv0MF/EyWL+XlpXOf9YnP3SPpXTCnGS1PMrwdOzWzPJWhZPvLgetAQg8V12s2tzdXLS3NgsEyboneKLYkjqecjoD9KyJdMKKvAGe2eQfStp4Oajzx1RzKqr2ZStXMbqwHINbrw2t5bqHkKnbwOmDWN5ZRsFcVc8wtAsZIIB4rz6sGmmOa6oSzZI02hskHp2NVbqFXuXMW0L6VbVl3jbhTn0qcwqfm2Dms+azITsznugzRu4wKRumKls7Zrq5SFTgucCuhJt2RvsOtoHuJkiQZZzgVoXFpFbzFLaZbgx8FhwM9605IGGlRWdkbYFCRcXKvwG9N3vWRBBIly0LoEJGCueCR71dSnyo6MK1KpZrcZB5xl8wKGGcGrBsQ1wxkk8tCerHk/SnpAot5LfBWQ/MFzTjAvmQ+eHLmPPXoRWN+x6qocsEpa9f+ATx75IpYBG6LH9xlPPFSWkcyO6ySxvLKv3SMtntVCOZ1AmimYSsfmGea1Ilia7dvOZZgchMdWI6ik1Y7aVSNWz1utN9LaieRcPabRgspIcRkD867nw3qSaZptlZ6kizT2su+J7R2MtvGwySQByM9vf2rgI5olsZbd1lWdmznPU10mnW9zqGsaZD4eV4NXhg3TTM5CsR69eMce9dVHTRnkZioTgpx6f195p+LI4LvTd1z4k01pEBdoU++78gHKgEEjGQe9cR9nd4VnLKDGADz19K9D8U6BpdzaRyX91YWPiO4kDTxNMdp4xjAzjPBriBZAw+S00W9sAICeCOtezhP3kXFnztVqDuhbi1S6sVQopnQcbOqj6ViMGimeF1IcHFdVHHEgG1wMR7SCM59MVnazAQy3EsWzA2FvX0rHM6CUPadRUK1/dMNsq/IwatwuAn3S3PrUbGN18xTuK9aat0oyNtfO/EdW5igbsZqZAoOM8H0qMYHY08DBzjivRguU0ep0dpYWFrc20eoybIbnDNA0m0x/KcFvqelPXw1LbaXc3rxl5YJAYvLkDrKnc8enrTNO8nWUR9QS2TyJEBmY4aQdNp9eBV7VJW1E2X9lQyW9tCfJZkOHiJOMMuenTmtpRUosKc3GSaOftpPNE77isp6ewqSBUEqym4LOOgNLqANnfzWxZHZcrvXoar20UmAzDaoYHJ6nFefyntLERg431/rcueaFDzLZgSqduf9qtuw0O+uG82G08uQx4LMcAk9/WodP1OzsiXeNWYnIDDNdHZePVhTMVizkelQ3JLRFvFK+n5W17kun+BNRcK9xdwBscEoSQfrxXRaX4Jewnllh1WeGSddsjQgAkexPI/CpfDXjFNWd457dYyuOK65YkOGX9KjmqJmVSu5w5JbHLz/D7TryZp7i6uJZHChmZuTt6VQk+Fdm8sktvqE8bvn5mAbGa7xiFTJrF1HxdpukfJPKGk/uIMmt4V6sdpHFKnGS+E4y9+HGo6dp0xt7mO+K/MBja/4ev51yl1El1Gout4GOU713U3xCF/M0cFtNEp+6xGK4rU/Ng1i6kf5UnO8HHPNdn1uc6UoVOxw1sPGK54mdPpsUUz+WhRDHuC5zurLudOlhYbonUMMjK9a6G2mP8AqmDMmMozY5qa4mDqguEkZBny9km3HrnNeCqrg9TCM2tzz1eevSnA5OBj8aaPQUpI49e4r3bWOkkGS6+nsa6drw6ZbrBcFJru4ZUuEwSREOVJI7nP6VzVtbNO2EHJOK6O1smRFMztIyjALc4HpUVK8YLTdmtKi6j8jL+xhblnC53MdqgVtWWiXF7t3DaKuWenxtIHfkk9a6a2nhsodxIGK891T0adBFCy8A2hAllnfd6Vpp4ctbF1VVDL64qS21iKV8syqp7s4UfrWwt3ZOFUzREsOCrhqh1JM39lTRm21jDZyb4xtyRXZabdeZAuSCQPWueniikgJjYEjmm6BqQW5MEnBzjJpqT6ilSVjrroM0BCj7wrkT4Rt3vnuZiWYnPJruSgNsDweK5LxJ4htNBtzLcyBSxwo7mrbcdjmpNSuh9j4c0yJx5kQkPoeRVDx14WsrjTI7iFFhZW2Er056frTNB8WyapBLcWthczJD9/ywuQPXBPNXNW1q31fwxdNC/mBSoZSNjKcjgjsaU5TUbszrJNPlPPJ7bydMgtw5muoj0I+Yj1qPKyqscwyYhj8+1S311tuUEYMm5e7cr/AI1jXF+jSfu3UYHLZPzGvPcHM8dROSzjmnQqZZlGeprrNQ0O0uopDCnk3C9V965aFGhuwjjaytg17HteZaHoyouDszprCzSKMFQM1ppHu6iq1jzGOeBWjEBurhlJt6npRSSsiSPESEmsnVtSlUKkanmt0QiVMdu9J/YIn2lAD9aE1cuztZHCXsN3JOpIkkU84AJFeseDk0q48JJb6pahpFY+SrR/OBj9Oao2ejzwsP8ARlJHetu3tLvb/BED1wOa6Y1bK1jL6unK7ZjRJfabegJzaO2AkjAuo/rUkxMV0sqHDA84rVuLNbePeRlh3NZLOMkse9c7ep1pHo+i3v2vT1RvvAVwfj/wbPrN5HdfavLjQYA2Fsetbvhm9wwTNdaYo5RhgCG7VrFtq5wVUqU3daM4LwHp9x4ftJYEmhuDMRmRgVKgdsd60dT8NqNO1KeOQtNPES20Y3Ecj8a6QabHHLuCKR64q75SGPbtGMdKuSlNamM6kFpBbnzTJexm2CpIzOhyCR055q1ollp09s8l+ju5b5TmpvF2jRaJ4uvLINtTPmJheityKx7e5RjIGlJCtgH1FYuOlonnuNnZG5rNw0N5GyIOQdxrlNVXF0swGN1djcot0T8o3oMEHrWDrtuptFkHOD1qoaNHs143iTafNmJTnqK1oJR0Nc5pbkwZHY1rwSfMKia1HB3ijorPDcetb+n24Zx6VzNpJjGDXSWNyAR/WszpgdJDAFUdKkMS+lRWc4deRVwLnvWiIbszF1WMCBuea4q4uMzMAeM12XiGQw2zbRk1xGmjzZmJ7mluzVPRG7oV2UmXOQQa9F0yYTxAE9uK87WOO0jDuyr6ZOK6nQ9Wh2KzNgY61cHZmOIhzw03Or3AcE0/txWNp2uwas0pt0fZE23cRwfpWurArmt0zyJQcXZnifxoVrbxVZXMYHz22GPrgmvPoEkkVpQB85ydpr0T4wSG98U2tpFBJMYrfLBBnGTXB39vc2LpGNpUrkArgj2IHes3KxlPR6HWaeVupiZAJFbjng1U1rSRbwSorOyE5AbtWdcXtzoMolK74y3K55/Cn3fjFNRh8mG3IJ6l6KlKUJHqqvCcfMxrEtFMyds1sW5+aqaJGx8xRgnrVuHO4YNTPUmnojdtuACDWxaSYYVj2R3JyOa04Mq2azaOmMjp7G54AznHatiGcFOeTXKwT+Wuc1etL8bvvVKlY0auWNWi88Feua5CGwudMvWZYRNEzEqN2CK6y4u1CEnkt0rPdnY7gAfaqQ7pGE2jJrGprJexkA+rE49hXfaLo9tYW4gAzkYBPPFY9vDvZMIByDn0rpYoguzOeBya1iY1G+hoWEEUMW2MAc88YqS4uo4IWxnCjkgdKrwS4t2fcDgHDZrK8R3pg0C5MUhV2TaGxnBNU3oec05SuzzvUbiPXfEct0lzHFJI20Ag7io4A96dqvhO1upI5VlETbcM46PWS2mwPlrS9f7RG27aO5+gqSbU7/Yke2SRkyGGD8pocROzIvGei3EuktcQxhvLILBRzjmuCsW23AB6GvbJIwFKv8wbuea8c1uzOm65c26jaI5CV47dR+ldtaHU5aUzR3GJ84O01dtmDf4VStnS7tFb+LvUls/ly7W6djXAux6l+qOks+3atiMgICCaw7WVcqc1sRSBwB2FZyRrFl08gDt3qQTeWD71X3HHPAq0kalMsBWRvcLm4KWwdu3PA5rKfxRDCjKsEzydPu4/nWgGUoUPIB4qFrKGRido/Kri11EldkFrqmt36k2sAjjA7uAa6Owi1ee3WO+ukiz3DbiKz9N04CQ5jxn/AGq6GygkRgpjTC9Ca3jKJrJxSJ9N0lYnYGWSRSMgk8H8KyfGUyR6db2bjKly7jOMgf8A666qFSqZ7kflWB42NrHoT3EsYd4GU8nHXjmj7R5s25XOBks7ayvVvoZjDGV4y2SB7GoSRdzyTWb7Y2I++3JPc1WC3OoR5iKJbht3P9BWTPd3SylY1Keo25B9+KHJXsccpJHodjci8tEwwLjg+/vXIfETw5cLKurRJuTaFlA6jHQ1qSM+g34m5Nvu+ZRyV/8ArV16taalpowyzRSr17EGvXnHmRxxfKzwrTLv7POFc/I/B9jW1LEfvL9Qah8XeGJvD2obkUmzmJMT+n+yfeodKv8AzEFtMfm/gJPX2rzKsGnc9KhUTXKzVs7wqNjHBHrW9aXOVAGPzrmngO7jrUsNxPbjB5FY3ujqV0dgs3y4JFWUfK43H6VzEOqgjLZFXo9RUYw1ZOLNlJGyFOPlqWHfnFUba9RsZYZPatKCaNuhHNS9DSLXQ0bQMuPWuksEJC7hnIrmYLlUnXkCt+LUbeGJcyDd6GqgRVd1ZGxPsitXkx0Ga8r8f6xNPBFpkRRknQSPzzkHgV1Ou+MrGCylgSUSOylSEOccV5X9nnjnimlR5FX5i/OGH1NdC7nC24xa7mSdduYm8hCUWPIVT6+9Upb67Zv3cr9OcGuh8YW9pqV1b39iUQzxfvBjGWHqema47LDoxFCjF62OJpX1Pc9S0xLy2dHKFiOAOtc9ol7caBPJYzLmHdkA/wAP0rqYypxuk6Dj3p1xosGpRbpQFYDhh/jXss5EyLUNOsvEekyW02JIpV+V1/hbsR9K8T1fSbrQdVksbkbZIzlWHRh2Ir02GS70nXJUt8PbpgmM9D9PetDxPoEHjrRRNZlV1C2BMSngt6qawqwuro1hKzsedaReC+URscSr1Hr71uPYgw8qM1wiG5029IIaKeF8MpGCCOoNeiaVfw6vponQ7XUYde4NeVVhyu62PWoVedWe5iS25jb5RxnpTokZjgAg1oTR/MQw79cVYtLSJsEnH1rPmNmrlOOK4/hJP1rX0y01G4mWKNRz3J6Vds7a3aYJvX8609WvYPDGizX7OpkC7YkJ+8x6UrtuyQ+XlV7nAXnjS6tb426QoBHLsZi2eAcGvXNL023/ALQtryICWzuIQ6Fm3bW71863bNJvlblnbJP1r0nwdd32q/C/VtPguZFubBvOt2RsMoGCR+Wa7nSi4WR5rrS5rtmfrPky+INQCkBDMxKg8DntWlM19ceHBab0iiwQgU4z9a461kvhcKfIaV0JLYzk+ua3ba/mEsZlgJjBIZT6HsK52mjVMjEq24SG8gVfMAO0jKSA/wBan1H4eS30q3WjGFLeQZ8qWTBQ+3qKdqUcF1NHLbqVChWKOu4D8e1dNperxpC8YlHynpjpTba1QcsXuS+H76HU7CGYPwy5xgZrqoIRsBzuA9Rj+VFFe03oeVJWZz2t2q22pi6jTcrr84FSWkS+at1ZM0T8blPeiiiwuhzXxY8KrPbL4nsoiHGFvEVcZ9H/AKH8K870PVX0u8Dg/un4kX1FFFcNSK1R1UpPc78RJcIHVgQwyCKmisxjsB6k0UV5b0dj2VqrnJ6zrptLphZAP5TYLnoayNX8R6jr7RC9kBSEYRFGAPf60UV2U4pJM8+rUk2430KM5/cgetd/8KWaCz1yVh+7S0csT0+6aKK6Y7nM9jEt769ls1u4iGx8rk+tbWn6nYXMAhLypc5/jA2+3NFFcclqzpUmdCOI/wB5B95NrBR1P9KY+lQSRRSxwRoXXn94UoorNG1kf//Z"
	}
}

返回结果

字段名 变量名 必填 类型 示例值 描述
bool 成功或失败

示例

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

业务异常码表

Code
（返回码） 		Message
（返回码描述） 		SubCode
（业务返回码） 		SubMessage
（业务返回码描述） 		解决方案
50000 业务处理失败 order.invalid-occupation 无效的占房信息
order.invalid-occupation-status 无效的占房状态
order.user-in-black-list 因客人，当前用户已被列入黑名单

9.查询入住信息

Order.QueryCheckins

应用场景

查询入住信息

请求参数

字段名 变量名 必填 类型 示例值 描述
酒店Id OrgId 是 long
订单Id OrderIds 否 long[]
占房Id OccupationIds 否 long[]
接待单Id CheckinIds 否 long[]
房间号 RoomNumbers 否 string[]
接待单状态 CheckinStatus 否 string[] I (I:入住、O：退房、S：挂账)如果不传此值，默认只查询在住的入住信息,只传入此字段搜索条件“I”可以查询指定酒店所有在住的字段
会员Id MemberId 否 string
手机号 Mobile 否 string
证件号 IdCardNumber 否 string 只传入此字段可以验证指定酒店是否已经存在使用相同证件号入住的订单
每页条数 PageSize 否 int 默认10
页码 PageIndex 否 int 页码从1开始

示例

                        {
        "ChannelKey":"web",
        "Method":"Order.QueryCheckins",
        "BizContent":"{"PageSize":1000,"PageIndex":1,"OrgId":660247752032257,
        "MemberId":"101517429"}",
        "Sign":"4C45094BD6FB5CDAB0A03BECA6C781C2",
        "SignType":"MD5",
        "Format":"json",
        "Charset":"utf-8",
        "Version":"1.0",
        "Timestamp":"2017-02-12 14:12:13"
    }

返回结果

字段名 变量名 必填 类型 示例值 描述
酒店Id OrgId 是 long
接待单Id CheckinId 是 long
订单Id OrderId 是 long
占房Id OccupationId 是 long
房间号 RoomNumber 是 string
账务Id BillId 是 long
接待单状态 CheckinStatus 是 string (I:入住、O：退房、S：挂账)
入住人 CheckinCustomer 是 Liaison
实际抵店时间 ActualArriveTime 是 DateTime
实际离店时间 ActualDepatureTime 是 DateTime
预计离店时间 EstimatedDepartureTime 是 DateTime
权益离店时间 BenefitDepartureTime 否 DateTime
接待备注信息 Memo 是 string
是否为主账单 IsMainBill 是 bool
是否联房 IsRelation 是 bool
联房记录 RelationCheckinInfos 否 RelationCheckinInfo[]
入住类型 CheckinType 是 int 0：全天房，1：时租房
房型编码 RoomTypeId 是 string
预订单号 OrderNo 是 string
渠道订单号 ChannelOrderNo 是 string
是否团队 IsGroup 是 bool
渠道 Channel 是 string

Liaison

字段名 变量名 必填 类型 示例值 描述
姓名 Name 否 string
手机 Mobile 否 string
性别 Gender 否 int 0：未知、1：女、2：男
国籍 Nationality 否 string
会员编号 MemberId 否 string
证件号 IdNo 否 string
证件类型 PersonalCredentialType 否 string 参考数据字典
出生日期 Birthday 否 string
民族 Race 否 string
客历编号 CustomerId 否 long
地址 Address 否 string

RelationCheckinInfo

字段名 变量名 必填 类型 示例值 描述
接待单编号 CheckinId 是 string
入住状态 CheckinStatus 是 string
房间号 RoomNumber 是 string

示例

                
                        {
                        "Code": 10000,
                        "Message": null,
                        "SubCode": null,
                        "SubMessage": null,
                        "Data": {
                        "PageSize": 10,
                        "PageIndex": 1,
                        "RecordCount": 1,
                        "PageCount": 1,
                        "Content": [
                        {
                        "OrgId": 2147483644,
                        "CheckinId": 1092659657768961,
                        "OrderId": 1092659653574657,
                        "OccupationId": 1092659653574657,
                        "RoomNumber": "8500",
                        "BillId": 1092659657768963,
                        "CheckinStatus": "I",
                        "CheckinCustomer": {
                        "Name": "齐天大圣",
                        "Mobile": "15055207126",
                        "Gender": 2,
                        "Nationality": "中国",
                        "MemberId": "000424773",
                        "IdNo": "110101199003073773",
                        "PersonalCredentialType": "C01",
                        "Birthday": "1990-03-07T00:00:00+08:00",
                        "Race": "R01",
                        "CustomerId": 1092659489996803,
                        "Address":""
                        },
                        "ActualArriveTime": "2020-08-04T15:15:18",
                        "ActualDepatureTime": null,
                        "EstimatedDepartureTime": "2020-08-05T12:00:00",
                        "Memo": "",
                        "IsMainBill": true,
                        "BenefitDepartureTime": "2020-08-05T12:00:00",
                        "IsRelation": true,
                        "RelationCheckinInfos": [
                        {
                        "CheckinId": 1092257740455937,
                        "CheckinStatus": "I",
                        "RoomNumber": "1008"
                        },
                        {
                        "CheckinId": 1092659657768961,
                        "CheckinStatus": "I",
                        "RoomNumber": "1009"
                        }
                        ],
                        "CheckinType": 0,
                        "RoomTypeId": "ST",
                        "OrderNo": "4B3N2Y0C001",
                        "ChannelOrderNo": null,
                        "IsGroup": false,
                        "Channel": "Hotel"
                        }
                        ]
                        }
                        }

10.查询在住单智能门锁信息

Order.QueryCheckinSmartDoorLocks

应用场景

查询在住单智能门锁信息,如果返回的是url,则需要跳转到此url开门，如果返回的是二维码，可以通过扫二维码开门

请求参数

字段名 变量名 必填 类型 示例值 描述
酒店Id OrgId 是 long
接待单Ids CheckinIds 是 long[]
包含门锁详细信息 IncludeLockDetail 是 bool

示例

                        {
        "ChannelKey":"web",
        "Method":"Order.QueryCheckinSmartDoorLocks",
        "BizContent":"{\"OrgId\":660247752032257,\"CheckinIds\":[660250554286081],
        \"IncludeLockDetail\":false}",
        "Sign":"F08ABCF5469AF4CAB3F63471BA3F385E",
        "SignType":"MD5",
        "Format":"json",
        "Charset":"utf-8",
        "Version":"1.0",
        "Timestamp":"2017-02-12 14:12:13"
}

返回结果（集合）

字段名 变量名 必填 类型 示例值 描述
接待单Id CheckinId 是 long
是否可以开锁 IsCanOpen 是 bool
路径 Uri 是 string
二维码 QRCode 是 string

示例

{
    "Code":10000,
    "Message":null,
    "SubCode":null,
    "SubMessage":null,
    "Data":[{
        "CheckinId":660250554286081,
        "IsCanOpen":false,
        "Uri":null,
        "QRCode":null}]
}

11.开门

Order.OpenCheckinSmartDoorLock

应用场景

此功能用于网络门锁开门，比如，客人办理入住后，客人可以在微信或者其它平台上进行网络开门

请求参数

字段名 变量名 必填 类型 示例值 描述
酒店Id OrgId 是 long
接待单Id CheckinId 是 long

示例

{
    "ChannelKey":"web",
    "Method":"Order.OpenCheckinSmartDoorLock",
    "BizContent":"{\"OrgId\":660247752032257,\"CheckinId\":660250554286081}",
    "Sign":"1A2FE5C0D7F7329BA7F1E01EFE67AA3A",
    "SignType":"MD5",
    "Format":"json",
    "Charset":"utf-8",
    "Version":"1.0",
    "Timestamp":"2017-02-12 14:12:13"
}

返回结果

字段名 变量名 必填 类型 示例值 描述
是 bool 是否开门成功

示例

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

12.查询未生成过房费的房间号

Order.QueryUnGeneratedRoomRent

应用场景

查询未生成过房费的房间号

请求参数

字段名 变量名 必填 类型 示例值 描述
酒店Id OrgId 是 long
接待单Ids CheckinIds 是 long[]

示例

{
    "ChannelKey": "web",
    "Method": "Order.QueryUnGeneratedRoomRent",
    "BizContent":"{\"OrgId\":2147483644,\"IsNeedCheckRoomRent\":false,
    \"IsNeedCheckRoomCharge\":false,\"CheckinIds\":[678841637535745]}",
    "Sign": "9FC45C716364EF9282C8B622A3993943",
    "SignType": "MD5",
    "Format": "json",
    "Charset": "utf-8",
    "Version": "1.0",
    "Timestamp": "2017-12-18 10:12:13"
}

返回结果

字段名 变量名 必填 类型 示例值 描述
是 string[] 返回房号

示例

{
    "Code": 10000,
    "Message": null,
    "SubCode": null,
    "SubMessage": null,
    "Data": ["8300"]
}

13.查询需要加收房费的房间

Order.QueryRoomRateCharge

应用场景

查询需要加收房费的房间

请求参数

字段名 变量名 必填 类型 示例值 描述
酒店Id OrgId 是 long
接待单Ids CheckinIds 是 long[]

示例

{
        "ChannelKey": "web",
        "Method": "Order.QueryRoomRateCharge",
        "BizContent":"{\"OrgId\":2147483644,\"IsNeedCheckRoomRent\":false,
        \"IsNeedCheckRoomCharge\":false,\"CheckinIds\":[1073741801]}",
        "Sign": "077DF646FCB26B7B9F3BA4E97D29C13B",
        "SignType": "MD5",
        "Format": "json",
        "Charset": "utf-8",
        "Version": "1.0",
        "Timestamp": "2017-12-18 10:12:13"
}

返回结果

字段名 变量名 必填 类型 示例值 描述
入住类型 CheckinType 是 string
推荐的加收规则 Rule 是 string 加收规则：0-不加收，1-加收半天，2-加收全天，3-时租房加收
最小加收规则 MinRule 是 string 加收规则：0-不加收，1-加收半天，2-加收全天，3-时租房加收
数量（时租房） Count 是 double 时租房超时小时数
是否显示全天房超时按小时加收的选项 ShowHoursSurchargeForDailyRoom 是 bool true: 显示全天房超时按小时加收的选项; false: 不显示全天房超时按小时加收的选项
加收明细 OccupationSurchargePartDetails 是 OccupationSurchargePartDetailInfo[]

OccupationSurchargePartDetailInfo

字段名 变量名 必填 类型 示例值 描述
占房Id OccupationId 是 long
房间详情 RoomDetail 是 string
加收金额 RoomSurcharge 是 decimal 用于时租房或者全天房按小时加收金额
是否显示全天房超时按小时加收的选项 ShowHoursSurchargeForDailyRoom 是 bool true: 显示全天房超时按小时加收的选项; false: 不显示全天房超时按小时加收的选项

示例

                
                        {
                        "Code": 10000,
                        "Message": null,
                        "SubCode": null,
                        "SubMessage": null,
                        "Data": [
                        {
                        "CheckinType": "Hour3",
                        "Rule": "3",
                        "MinRule": "3",
                        "Count": 2,
                        "ShowHoursSurchargeForDailyRoom": false,
                        "OccupationSurchargePartDetails": [
                        {
                        "OccupationId": 1092257635598337,
                        "RoomDetail": "8138 - 哈哈笑",
                        "RoomSurcharge": 50,
                        "ShowHoursSurchargeForDailyRoom": false
                        }
                        ]
                        }
                        ]
                        }

14.退房

Order.Checkout

应用场景

客人办理离店退房

请求参数

字段名 变量名 必填 类型 示例值 描述
酒店Id OrgId 是 long
是否检查必须有房费 IsNeedCheckRoomRent 是 bool
是否检查房费加收 IsNeedCheckRoomCharge 是 bool
接待单Ids CheckinIds 是 long[]

示例

                             {
     "ChannelKey": "web",
     "Method": "Order.Checkout",
     "BizContent":"{\"OrgId\":2147483644,\"IsNeedCheckRoomRent\":false,
     \"IsNeedCheckRoomCharge\":false,\"CheckinIds\":[678841637535745]}",
     "Sign": "01EB9CC9836EB1A33280E01E103A5A3E",
     "SignType": "MD5",
     "Format": "json",
     "Charset": "utf-8",
     "Version": "1.0",
     "Timestamp": "2017-12-18 10:12:13"
}

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

{
    \"OrgId\":2147483644,
    \"IsNeedCheckRoomRent\":false,
    \"IsNeedCheckRoomCharge\":false,
    \"CheckinIds\":[678841637535745]
}

返回结果

字段名 变量名 必填 类型 示例值 描述
接待单号 CheckinId 否 long
是否离店 IsCheckout 否 bool

示例

{
        "Code": 10000,
        "Message": null,
        "SubCode": null,
        "SubMessage": null,
        "Data": [
            {
                "CheckinId": 678841637535745,
                "IsCheckout": true
            }
        ]
}

15.变更离店日期

Order.ChangeStay

应用场景

客人变更离店日期

请求参数

字段名 变量名 必填 类型 示例值 描述
酒店Id OrgId 是 long
接待单 Id CheckinId 是 long
操作方式 OperateType 是 string ExtendStay：续 住，UnderStay： 提前离店
新离店日期 NewDepartureTime 是 DateTime
原因 Reason 是 string
续住规则 ContinueLivePolicy 否 string 市场价格 Market, 最后一天价格: LastDay, 首日价格： FirstDay, 最高价格：Top, 最低价格 Bottom, 平均价格 Average ,自定义价 Custom
自定义价 CustomDailyPrices 否 CustomDailyPrice[] 当续住规则是自定义价时必传

CustomDailyPrice

字段名 变量名 必填 类型 示例值 描述
日期 Date 是 DateTime
价格 Price 是 decimal

示例


{
     "ChannelKey": "web",
     "Method": "Order.ChangeStay",
     "BizContent": "{\"CheckinId\":1232277943222273,\"OrgId\":2147483644,\"OperateType\":\"ExtendStay\",
    \"NewDepartureTime\":\"2021-6-26\",\"Reason\":\"test\",\"ContinueLivePolicy\":\"Custom\",
    \"CustomDailyPrices\":[{\"Date\":\"2021-6-25\",\"Price\":199}]}",
     "Sign": "01EB9CC9836EB1A33280E01E103A5A3E",
     "SignType": "MD5",
     "Format": "json",
     "Charset": "utf-8",
     "Version": "1.0",
     "Timestamp": "2021-6-24 10:12:13"
}

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

{
        "{\"OrgId\":2147483644,\"CheckinId\":826159588048901,\"OperateType\":\"ExtendStay\"
      ,\"NewDepartureTime\":\"2018-11-27T17:00:00\",\"Reason\":\"客人续住\",\"ContinueLivePolicy\":\"LastDay\"}"
}

返回结果

字段名 变量名 必填 类型 示例值 描述
接待单号 CheckinId 是 long
入住No CheckinNo 否 string
预订单号 OrderId 是 long
占房ID OccupationId 是 long
房号 RoomNumber 否 string
账务Id BillId 是 long
账务No BillNo 否 string
入住状态 CheckinStatus 是 int 入住=0，退房=1，挂账=2
入住人 ChangeOrderStayGuest 是 ChangeOrderStayGuest
实际入住时间 ActualArriveTime 是 DateTime
实际离店时间 ActualDepatureTime 否 DateTime
预计离店时间 EstimatedDepartureTime 是 DateTime
渠道 Channel 是 string
备注 Memo 否 string
是否为主账号 IsMainBill 是 bool

ChangeOrderStayGuest

字段名 变量名 必填 类型 示例值 描述
客人姓名 Name 是 string
性别 Gender 是 int
电话 Phone 否 string
手机 Mobile 否 string
传真 Fax 否 string
Email Email 否 string
国籍 Nationality 否 string

示例

{
    "Code": 10000,
    "Message": null,
    "SubCode": null,
    "SubMessage": null,
    "Data": {
        "CheckinId": 826159588048901,
        "CheckinNo": "399SER0O005",
        "OrderId": 826146841559045,
        "OccupationId": 826146841559048,
        "RoomNumber": "8402",
        "BillId": 826159588048904,
        "BillNo": "399SER0O008",
        "CheckinStatus": 0,
             "ChangeOrderStayGuest":{
            "Name": "测测试试",
            "Gender": 0,
            "Phone": null,
            "Mobile": null,
            "Fax": null,
            "Email": null,
            "Nationality": null
        },
        "ActualArriveTime": "2018-11-26T17:41:49",
        "ActualDepatureTime": null,
        "EstimatedDepartureTime": "2018-11-27T17:00:00",
        "Channel": "Hotel",
        "Memo": "",
        "IsMainBill": false
    }
}

业务异常码表

Code
（返回码） 		Message
（返回码描述） 		SubCode
（业务返回码） 		SubMessage
（业务返回码描述） 		解决方案
50000 业务处理失败 order.invalid-checkin-id 无效的入住单Id
order.checkin-room-notroomrent 房间号:101未生成房费
order.checkin-room-charge 已过离店时间，需要加收房费

16.换房

Order.ChangeRoom

应用场景

换房（仅支持入住人与同住人一起换房，不支持单个换房）

请求参数

字段名 变量名 必填 类型 示例值 描述
酒店Id OrgId 是 long
接待单Id CheckinId 是 long
目标房间号 DestRoomNumber 是 string
换房原因 Memo 是 string

示例

                        
{
  "ChannelKey": "web",
  "Method": "Order.ChangeRoom",
  "BizContent": "{\"CheckinId\":1186397325262852,\"OrgId\":2147483644,\"DestRoomNumber\":\"8308\",
                            \"Memo\":\"%E4%BF%83%E9%94%80%E7%89%B9%E6%83%A0\"}",
    "Sign": "5098459FDE9D848607A9C54E872BD5A5",
    "SignType": "MD5",
    "Format": "json",
    "Charset": "utf-8",
    "Version": "1.0",
    "Timestamp": "2021-03-10 10:50:40"
}

返回结果

字段名 变量名 必填 类型 示例值 描述
否 long[] [ 1186397325262852, 1187190988062722 ] 换房成功的CheckinId列表

示例

{
    "Code": 10000,
    "Message": null,
    "SubCode": null,
    "SubMessage": null,
    "Data": [
        1186397325262852,
        1187190988062722
       ]
    }

17.修改订单备注

Order.UpdateOrderMemo

应用场景

修改订单备注

请求参数

字段名 变量名 必填 类型 示例值 描述
酒店Id OrgId 是 long
订单Id OrderId 是 long 1192904144683015
备注 Memo 否 string 我是备注 Memo=null 默认删除备注

示例

                            
                                    {
                                    "BizContent": "{\"OrgId\":2147483644,\"OrderId\":1192904144683015,\"Memo\":\"我是备注\"}",
                                    "ChannelKey": "Hotel",
                                    "Charset": "utf-8",
                                    "Domain": "www",
                                    "Format": "json",
                                    "Method": "Order.UpdateOrderMemo",
                                    "Sign": "c4ef6d97d2097c0ef8c1d735d118c05775d0a0923875b4d9f5bf7b7b2a736395",
                                    "SignType": "SHA256",
                                    "Timestamp": "2019-03-02 11:42:00",
                                    "Version": "1.0"
                                    }

返回结果


示例

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

业务异常码表

Code
（返回码） 		Message
（返回码描述） 		SubCode
（业务返回码） 		SubMessage
（业务返回码描述） 		解决方案
50000 业务处理失败 order.order-not-found 订单不存在

18.修改入住单备注

Order.UpdateCheckinMemo

应用场景

修改入住单备注

请求参数

字段名 变量名 必填 类型 示例值 描述
酒店Id OrgId 是 long
入住单Id CheckinId 是 long 1192904144683015
备注 Memo 否 string 我是入住单备注[tip]我是退房提醒 [tip]是分隔符，前面内容是入住单备注，后面是客人退房提醒

示例

                                
                                    {
                                    "BizContent": "{\"OrgId\":2147483644,\"CheckinId\":1192906287972353,\"Memo\":\"我是入住单备注[tip]我是退房提醒\"}",
                                    "ChannelKey": "Hotel",
                                    "Charset": "utf-8",
                                    "Domain": "www",
                                    "Format": "json",
                                    "Method": "Order.UpdateCheckinMemo",
                                    "Sign": "c4ef6d97d2097c0ef8c1d735d118c05775d0a0923875b4d9f5bf7b7b2a736395",
                                    "SignType": "SHA256",
                                    "Timestamp": "2019-03-02 11:42:00",
                                    "Version": "1.0"
                                    }

返回结果


示例

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

业务异常码表

Code
（返回码） 		Message
（返回码描述） 		SubCode
（业务返回码） 		SubMessage
（业务返回码描述） 		解决方案
50000 业务处理失败 order.checkin-not-found 入住单不存在