第三方系统根据此接口定义实现查询订单方法,并暴露成服务。去啊系统实时调用第三方的查询订单服务来获取订单详细信息。
接收阿里旅行调用接口方式
1. 由第三方提供一个接收阿里请求的服务地址(注意:所有的接口请求均用这个相同的地址),以及用于验证的用户名和密码。
2. 第三方根据请求参数中的xml父节点区分业务请求类型,根据文档要求开发接收请求数据和返回相应的数据
请求参数
名称 |
类型 |
是否必须 |
最大长度/取值范围 |
描述 |
示例值 |
Username |
String |
是 |
100 |
第三方系统接口调用需要校验时的用户名 |
taobao |
Password |
String |
是 |
100 |
第三方系统接口调用需要校验时的密码 |
taobao |
CreateToken |
String |
是 |
255 |
单次请求token |
taobao1387784033263-1387784033266 |
OrderId |
String |
否 |
100 |
OTA订单id,即第三方系统中的订单id 备注:当OrderId为空时,表示本次查询为异步下单后发起的查询请求;OrderId非空时表示普通的查询请求。 |
21544874 |
TaoBaoOrderId |
long |
是 |
|
taobao订单id |
524148745 |
HotelId |
String |
是 |
64 |
OTA酒店id,即第三方系统中的酒店id |
80 |
QueryType |
int |
否 |
10 |
查询请求类型 |
查询类型。 1-普通查询; 2-下单过程中的查询(一般是进行对订单状态的确认); 3-取消订单过程中的查询; 4:系统状态补偿查询 |
XML示例:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <QueryStatusRQ> <AuthenticationToken> <Username>taobao</Username> <Password>taobao</Password> <CreateToken>taobao1230123213-1387792484913</CreateToken> </AuthenticationToken> <OrderId>12321323</OrderId> <TaoBaoOrderId>1230123213</TaoBaoOrderId> <HotelId> OTA酒店id</HotelId> <QueryType>1</QueryType> </QueryStatusRQ> |
返回结果(成功)
名称 |
类型 |
是否必须 |
限制 范围 |
描述 |
示例值 |
Message |
String |
是 |
100 |
处理结果 |
处理成功 |
ResultCode |
String |
是 |
取值: 0 |
处理结果,0表示成功 |
0 |
TaoBaoOrderId |
long |
是 |
|
淘宝订单id |
1387784033263 |
OrderId |
String |
否 |
100 |
OTA订单id,即第三方系统中的订单id (注意:如果是异步下单,此字段为必填字段) |
21544874 |
Status |
String |
是 |
取值:参见status表定义 |
第三方系统订单状态 |
1 |
PmsResID |
String |
否 |
100 |
PMS的确认单号 |
F15F190223 |
Comment |
String |
否 |
100 |
外部订单说明 |
渠道来源/其他订单标识 |
OrderInfo |
OrderInfo |
否 |
|
订单信息 备注:订单状态为checkin之后需要返回此节点 |
|
CheckIn |
Timestamp |
否 |
yyyy-MM-dd HH:mm:ss |
入住时间 |
2013-12-24 00:00:00 |
CheckOut |
Timestamp |
否 |
yyyy-MM-dd HH:mm:ss |
离店时间 |
2013-12-26 00:00:00 |
RoomQuantity |
int |
否 |
取值:1-9 |
实际入住房间数量 |
2 |
Hotel |
String |
否 |
|
实际的酒店名称 |
|
RoomType |
String |
否 |
|
实际的房型名称 |
|
BillInfo |
BillInfo |
否 |
|
帐单信息 备注:订单状态为checkout之后需要返回此节点 |
|
RoomNo |
String |
否 |
|
房号 |
121 |
TotalRoomPrice |
long |
是 |
|
总价(分)可用于价格预警 |
88800 |
OtherFee |
long |
是 |
|
杂费,客人的其他消费,资损费用除外 总价(分)可用于价格预警 |
660 |
Remark |
String |
否 |
|
备注 |
|
DailyPrice |
List<Unit> |
否 |
|
每日房费列表 |
|
Date |
Date |
否 |
yyyy-MM-dd |
日期 |
|
Price |
long |
否 |
|
每日金额,总价(分) |
220 |
OtherFeeDetail |
List<Unit> |
否 |
|
杂费明细 |
|
Name |
String |
否 |
|
杂费名称 |
洗衣费 |
Price |
long |
否 |
|
杂费金额,总价(分) |
220 |
XML示例:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Result> <Message>处理成功</Message> <ResultCode>0</ResultCode> <Status>1</Status> < OrderId >123456</ OrderId > < TaoBaoOrderId >1387784033263</ TaoBaoOrderId > <PmsResID> F15F19022</PmsResID> <Comment> 渠道A订单</Comment> <TotalRoomPrice>填入订单总房费,可用于价格预警</TotalRoomPrice> <OtherFee>填入订单杂费,可用于价格预警</OtherFee> <OrderInfo> <CheckIn>2015-08-10 00:00:00</CheckIn> <CheckOut>2015-08-12 00:00:00</CheckOut> <RoomQuantity>1</RoomQuantity> <Hotel>好又来大酒店</Hotel> <RoomType></RoomType> </OrderInfo> <BillInfo> <RoomNo></RoomNo> <TotalRoomFee>房费总计,杂费不计算在内,单位分</TotalRoomFee> <DailyPrice> <Unit> <Date>2015-08-10</Date> <Price>20000</Price> </Unit> <Unit> <Date>2015-08-11</Date> <Price>20000</Price> </Unit> </DailyPrice> <OtherFee>4000</OtherFee> <OtherFeeDetail> <Unit> <Name>洗衣费</Name> <Price>2000</Price> </Unit> <Unit> <Name>收费毛巾</Name> <Price>1500</Price> </Unit> </OtherFeeDetail> <Remark>备注</Remark> </BillInfo> </Result> |
返回结果(失败)
名称 |
类型 |
是否必须 |
限制范围 |
描述 |
示例值 |
Message |
String |
是 |
300 |
错误原因 |
查询失败 |
ResultCode |
String |
是 |
取值: 0,-301,-302 |
错误码 |
-300 |
OrderId |
String |
是 |
100 |
OTA订单id,即第三方系统中的订单id |
21544874 |
XML示例:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Result> <Message>查询失败</Message> <ResultCode>-301</ResultCode> < OrderId >21544874</ OrderId > </Result> |
返回结果定义表
以下是第三方接到查询订单请求后,处理成功或失败时应该返回的结果。此表已定义结果类型不会修改,但可能会根据业务情况进行增补。
ResultCode |
Message |
备注 |
0 |
查询成功 |
返回查询订单信息 |
-301 |
查询失败 |
其余所有失败情况都返回此值 |
-302 |
订单不存在 |
卖家系统未找到当前要查询的订单信息 |
第三方查询订单服务返回的订单状态必须对应到下表中的一种:
Status取值 |
说明 |
备注 |
1 |
订单已经确认 |
下单成功 |
2 |
订单未确认 |
下单失败、满房等 |
3 |
订单等待处理中 |
处理中 |
4 |
订单已取消 |
此值保留 |
5 |
已入住 |
|
6 |
订单关闭 |
|
7 |
订单删除 |
|
8 |
客人NoShow |
|
9 |
客人离店 |
|
注:第三方订单状态,除了以上表中数值,不允许返回其余值。