文档中心 >

未来酒店-订单信息更新接口

更新时间：2018/04/19 访问次数：23603

请求入参
接口适用业务及定义
预约发票
预约发票请求示例
在线选房
在线选房请求示例
扫脸入住信息（非自助入住）
扫脸入住请求示例
自助入住信息
自助入住请求示例
自助入住请求示例(升级版)
智能门锁(在线自助开门) 未上线
酒店PMS信息查询
通用任务撤销请求
通用返回格式

订单信息更新接口/请求下发接口

场景

飞猪平台通过调用此接口进行订单信息变更，平台请求下行至PMS。
用于订单信息变更的下传。基本信息、发票、在线选房、智能门锁、自助check in、扫脸入住等

要求

需要商家按定义的协议实现服务接收和处理。
根据飞猪订单号做幂等处理，即同一订单，多次调用均可返回成功。
处理能力要有合理评估并告知，飞猪会根据性能要求投放流量。

第三方系统根据此接口定义实现订单更新，并暴露成服务。飞猪系统在用户订单变更时候调用

本接口支持的操作类型定义：

对应UpdateRQ中OperateType, 更新请求

(详细operateType定义参见 //open.alitrip.com/docs/doc.htm?&docType=1&articleId=104397)

0: 基本信息更新
1: 预约开发票请求
3: 在线选房请求
4: 自助checkIn请求 (new)
9：取消开发票请求
13：扫脸入住身份信息请求 (new)
15：酒店PMS信息查询
101 通用指令
103 撤销请求操作

注：此文档会根据业务需要进行适当增删除。

请求入参

数据字典定义（具体请求格式见后文定义）

名称	类型	是否必需	最大长度	描述	示例值
UpdateRQ	复合类型	是		请求协议体
Username	String	是	100	第三方系统接口调用需要校验时的用户名。	Taobao
Password	String	是	100	第三方系统接口调用需要校验时的密码	1234
CreateToken	String	是	255	单次请求的token	Taoao333333333333
TaoBaoOrderId	Long	是（扫脸入住可为空）	32	淘宝订单号	1387784033263
OrderId	String	是（扫脸入住可为空）	32	外部订单号	R333333
RequestID	String	是	32	请求唯一标识,此值需要在结果中返回	taobao1387784033263
HotelCode	String	是	64	外部酒店编码	h00007654
OperateType	int	是	10	本次更新的操作类型，此值必须传入，默认0，更新基本信息。目前包括： 0: 更新联系人、备注、入住人时间等基本信息； 1：预约开发票请求； 3：在线选房请求 4：自助办理入住（new） 9：取消开发票请求 13：扫脸入住身份信息请求 (new) 101：通用指令类请求（与action配合实现想要表达的意图，内容写入请求上下文）OperateTypeEnum文件定义 103 请求撤销指令	1
Action	int	是	10	PMS处理消息的动作 0: 普通，不需要特殊动作 1：弹窗提示（Pms中央模态窗） 2：托盘信息提示（给酒店广播通知或者平台公告） 3:发送请求给酒店前台人员，前台人员需要看到后确认处理(比如督促前台结账、督促前台上报入住状态) 4：请求pms自动处理(自动发起结账，自动上报订单状态等)	0
Status	Int	是	10	阿里旅行平台请求的处理状态： 0：新建 1：请求已经被读取过 2：请求已经被认领 3：请求已经反馈 4：处理完成 5：请求失效	1
DisplayText	String	否		建议PMS提示文案
Extensions	String	否	512	扩展字符串json格式
RoomSelect/ Invoice/ CheckInInfo/ FaceScanInfo/	复合类型	是		具体业务请求操作XML数据： RoomSelect：在线选房业务请求 Invoice: 预约发票业务请求 CheckInInfo: 自助入住信息请求 FaceScanInfo:扫脸入住身份信息请求

接口适用业务及定义

预约发票

如UpdateRQ请求中的OperateType=1且业务节点为Invoice时，则说明该请求为预约发票请求。具体业务数据节点Invoice节点包含：

Invoice业务数据定义

名称	类型	是否必需	最大长度	描述	示例值
InvoiceType	int	是		发票类型（1:普通发票；2：增值税专用发票）	1
InvoiceTitle	String	是	50	发票抬头	阿里巴巴集团
TaxpayerID	String	否	50	纳税人识别号：纳税人识别号,一律由15位、18或者20位码（字符型）组成。
PostType	int	是	10	发票领取方式 0：前台自取 1：邮寄 2：电子发票 3: 送票到房	0
EarlyPrepare	int	是	10	发票是否需要提前准备 0：不提前开发票 1: 需要提前开好发票	0
RegAddress	String	否	100	公司注册地址：抬头公司注册地址
ReceiverName	String	否	10	收件人姓名	张三
ReceiverMobile	String	否	50	收件人手机号	1380987653
ReceiverAddress	String	否	100	收件地址	北京国家广告产业园B座
Provider	Int	是	10	发票提供方（发票由谁来提供） 1：酒店前台 2: 商家提供 3：去啊平台提供	1一般由前台提供
Payer	Int	是	10	邮费支付方	邮费承担方 1：酒店承担 2：商家承担 3：去啊平台承担 4：客户自己承担
WantTime	Datetime	是		用户期望取票时间
CompanyTel	String	否		公司电话：抬头公司电话，区号-电话号码
BankName	String	否		开户行：抬头公司银行开户行名称
BankAccount	String	否		银行账户：抬头公司银行账号
Comment	String	否		备注说明

预约发票请求示例

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<Username>taobao</Username>

<Password>taobao</Password>

<CreateToken>taobao1387784033263-1387784033266</CreateToken>

</AuthenticationToken>

<RequestID>请求唯一标识,此值需要在结果中返回</RequestID>

<HotelCode>外部酒店编码</HotelCode>

<DisplayText>用户张三需要提前准备发票</DisplayText>

<InvoiceType>发票类型（1:普通发票；2：增值税专用发票）</InvoiceType>

<InvoiceTitle>阿里巴巴集团</InvoiceTitle>

<TaxpayerID>纳税人识别号：纳税人识别号,一律由15位、18或者20位码（字符型）组成。</TaxpayerID>

<RegAddress>公司注册地址：抬头公司注册地址</RegAddress>

<CompanyTel>公司电话：抬头公司电话，区号-电话号码</CompanyTel>

<BankName>开户行：抬头公司银行开户行名称</BankName>

<BankAccount>银行账户：抬头公司银行账号</BankAccount>

<ReceiverAddress> 北京国家广告产业园B座</ReceiverAddress>

<WantTime>需要发票时间(格式yyyy-MM-dd HH:mm:ss)</WantTime>

</Invoice>

</UpdateRQ>

在线选房

如UpdateRQ请求中的OperateType=3且业务节点为RoomSelect时，则说明该请求为在线选房请求。具体业务数据节点RoomSelect节点包含：

RoomSelect业务数据定义

名称	类型	是否必需	最大长度	描述	示例值
Type	Int	是	10	1:选房操作；2: 取消选房；3: 变更选房	1
RoomTypeID	String	否	10	订单绑定外部房型ID	1009
BuildingNum	String	否	10	楼号	1009
Floor	String	否	10	楼层	2
RoomNum	String	否	10	所选房间号（如果订单为多间房，则所选房号以字符“\|”分隔。例：“8208:8205”）	1
OldRoomNum	String	否	10	原始房号	333

在线选房请求示例

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<Username>taobao</Username>

<Password>taobao</Password>

<CreateToken>taobao1387784033263-1387784033266</CreateToken>

</AuthenticationToken>

<RequestID>请求唯一标识,此值需要在结果中返回</RequestID>

<HotelCode>外部酒店编码</HotelCode>

<DisplayText>用户张三选房操作</DisplayText>

<RoomTypeID>订单绑定外部房型ID</RoomTypeID>

<RoomNum>所选房间号（如果订单为多间房，则所选房号以字符“|”分隔。例：“8208|8205”）</RoomNum>

<OldRoomNum>原始房间号(变更选房时候有效)</OldRoomNum>

</RoomSelect>

</UpdateRQ>

扫脸入住信息（非自助入住）

如UpdateRQ请求中的OperateType=13且业务节点为FaceScan时，则说明该请求为扫脸入住信息请求（提供给扫脸设备厂商使用）。

具体业务数据节点FaceScanInfo节点包含多个guest信息：

FaceScanInfo业务数据定义

名称	类型	是否必需	最大长度	描述	示例值
Guests.GuestName	String	是	32	姓名	1
Guests.CertificateType	Int	是	6	证件类型	20代表身份证
Guests.CertificateNum	String	是	32	证件号	367719189009873678

扫脸入住请求示例

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<Username>taobao</Username>

<Password>taobao</Password>

<CreateToken>taobao1387784033263-1387784033266</CreateToken>

</AuthenticationToken>

<TaoBaoOrderId>设置为空, 扫脸入住不传</TaoBaoOrderId>

<OrderId>设置为空, 扫脸入住不传</OrderId>

<RequestID>请求唯一标识,此值需要在结果中返回</RequestID>

<HotelCode>外部酒店编码</HotelCode>

</FaceScanInfo>

</UpdateRQ>

自助入住信息

CheckInInfo业务数据定义

名称	类型	是否必需	最大长度	描述	示例值
RoomNum	String	否	10	房间号	8008
DeviceId	String	是	32	设备id	NO12001
Guests.Guest.GuestName	String	是	32	姓名	1
Guests.Guest.CertificateType	Int	6	6	证件类型	20代表身份证
Guests.Guest.CertificateNum	String	32	32	证件号	367719189009873678

自助入住请求示例

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<Username>taobao</Username>

<Password>taobao</Password>

<CreateToken>taobao1387784033263-1387784033266</CreateToken>

</AuthenticationToken>

<RequestID>请求唯一标识,此值需要在结果中返回</RequestID>

<HotelCode>外部酒店编码</ HotelCode>

</CheckInInfo>

</UpdateRQ>

自助入住请求示例(升级版)

<CheckInInfoRQ>
<IsPressure>true</IsPressure>
<PmsOrderId/>
<Tid>111</Tid>
<HotelOrderId>123</HotelOrderId>
<NewOrderId>123</NewOrderId>
<IsSelfCheckIn>true</IsSelfCheckIn>
<IsCreditCheckIn>true</IsCreditCheckIn>
<Hid>123</Hid>
<AssociateId>123</AssociateId>
<HotelCode>123</HotelCode>
<Vendor>11</Vendor>
<Action>zz</Action>
<DisplayText>zz</DisplayText>
<Attributes>zz</Attributes>
<CheckInInfo>
<DeviceId>XX111</DeviceId>
<Price>100</Price>
<RoomNum>1212</RoomNum>
<CreditCheckInLimit>1000</CreditCheckInLimit>
<CheckInDate>2018-02-02 14:00:00</CheckInDate>
<CheckOutDate>2018-02-02 14:00:00</CheckOutDate>
<GuestInfo>
<Address>乐佳国际</Address>
<Birthday>2018-02-02</Birthday>
<Base64Img>111111</Base64Img>
<CertificateNum>333333201803038888</CertificateNum>
<CertificateType>1</CertificateType>
<City>杭州</City>
<Country>中国</Country>
<FirstName>lai</FirstName>
<GuestName>未来</GuestName>
<GuestNamePinYin>weilai</GuestNamePinYin>
<IsMain>true</IsMain>
<LastName>wei</LastName>
<Message>消息</Message>
<Nation>中国</Nation>
<Phone>18877776666</Phone>
<Province>浙江</Province>
<Sex>男</Sex>
<SignOffice>中华人民共和国</SignOffice>
<UsefulEDate>2018-02-02</UsefulEDate>
<UsefulSDate>2018-02-02</UsefulSDate>
</GuestInfo>
<GuestInfo>
<Address>乐佳国际</Address>
<Birthday>2018-02-02</Birthday>
<Base64Img>111111</Base64Img>
<CertificateNum>333333201803038885</CertificateNum>
<CertificateType>1</CertificateType>
<City>杭州</City>
<Country>中国</Country>
<FirstName>lai2</FirstName>
<GuestName>未来2</GuestName>
<GuestNamePinYin>weilai2</GuestNamePinYin>
<IsMain>true</IsMain>
<LastName>wei</LastName>
<Message>消息</Message>
<Nation>中国</Nation>
<Phone>18877776665</Phone>
<Province>浙江</Province>
<Sex>男</Sex>
<SignOffice>中华人民共和国</SignOffice>
<UsefulEDate>2018-02-02</UsefulEDate>
<UsefulSDate>2018-02-02</UsefulSDate>
</GuestInfo>
</CheckInInfo>
</CheckInInfoRQ>

智能门锁(在线自助开门) 未上线

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<Username>taobao</Username>

<Password>taobao</Password>

<CreateToken>taobao1387784033263-1387784033266</CreateToken>

</AuthenticationToken>

<RequestID>请求唯一标识,此值需要在结果中返回</RequestID>

<HotelCode>外部酒店编码</HotelCode>

</UpdateRQ>

酒店PMS信息查询

<QueryOrderInfoRQ>
<IsPressure>true</IsPressure>
<Tid>taobao_4153232</Tid>
<HotelOrderId>14323242</HotelOrderId>
<PmsOrderId>xms_2323412</PmsOrderId>
<Phone>18877776666</Phone>
<CredId>333333201803038888</CredId>
<SignOffice>中华人民共和国</SignOffice>
<UsefulSDate>2018-02-02</UsefulSDate>
<UsefulEDate>2018-02-02</UsefulEDate>
<Message>其他</Message>
<Name>未来</Name>
<PinyinName>weilai</PinyinName>
<FirstName>lai</FirstName>
<LastName>wei</LastName>
<Country>中国</Country>
<Province>浙江省</Province>
<City>杭州市</City>
<Address>乐佳国际</Address>
<Nation>汉</Nation>
<Base64Img>1111111</Base64Img>
<Birthday>2018-02-02</Birthday>
<Sex>男</Sex>
<CheckInDate>2018-02-02 14:00:00</CheckInDate>
<CheckOutDate>2018-02-03 12:00:00</CheckOutDate>
<HotelCode>KAJDD</HotelCode>
<DeviceId>KKAJ2342</DeviceId>
</QueryOrderInfoRQ>

通用请求事项

逾期未结账订单待办事项

异常订单待办事项

客房服务待办事项

通用任务撤销请求

用于取消某个任务（pms接到此消息，之后不再需要处理此任务），UpdateRQ中的OperateType = 103

示例：

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<Username>taobao</Username>

<Password>taobao</Password>

<CreateToken>taobao1387784033263-1387784033266</CreateToken>

</AuthenticationToken>

<RequestID>请求唯一标识,此值需要在结果中返回</RequestID>

< HotelCode>外部酒店编码</ HotelCode>

<DisplayText>用户撤销开门 </DisplayText>

</UpdateRQ>

通用返回格式

名称	类型	是否必需	最大长度	描述	示例值
Result	复合类型	是
ResultCode	int	是	10	结果返回（0：处理成功； 1：处理失败）	0
Message	String	是	50	结果描述对于自助入住类型，需要返回xml格式。	更新成功
OrderId	String	是（扫脸入住非必填）	50	商家外部订单号	R33888888
PmsResID	String	否	50	PMS订单号	建议填充
RequestID	String	是	64	请求序列号，唯一请求标识，必须返回	请求参数中传递过来的值

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<Message>描述（自助入住类型支持返回XML格式)</Message>

<ResultCode>0:成功；1:失败；101：订单还未下达酒店PMS，请稍后再试</ResultCode>

<OrderId>商家外部订单号</OrderId>

<PmsResID>PMS订单号</PmsResID>

<RequestID>请求流水号返回</RequestID>

</Result>

自助入住类型支持返回XML格式(Message节点定义)

FAQ

关于此文档暂时还没有FAQ

有用(1) 我要提问

开放平台

未来酒店-订单信息更新接口

场景

要求

本接口支持的操作类型定义：

请求入参

接口适用业务及定义

预约发票

Invoice业务数据定义

预约发票请求示例

在线选房

RoomSelect业务数据定义

在线选房请求示例

扫脸入住信息（非自助入住）

FaceScanInfo业务数据定义

扫脸入住请求示例

自助入住信息

CheckInInfo业务数据定义

自助入住请求示例

自助入住请求示例(升级版)

智能门锁(在线自助开门) 未上线

酒店PMS信息查询

通用请求事项

通用任务撤销请求

通用返回格式

自助入住类型支持返回XML格式(Message节点定义)

FAQ